A lightweight library for adding fault tolerance to large-scale PyTorch distributed training workloads.
Project description
torchsnapshot
This library is currently in Alpha and currently does not have a stable release. The API may change and may not be backward compatible. If you have suggestions for improvements, please open a GitHub issue. We'd love to hear your feedback.
A light-weight library for adding fault tolerance to large-scale PyTorch distributed training workloads.
Install
Requires Python >= 3.7 and PyTorch >= 1.11
From pip:
pip install --pre torchsnapshot-nightly
From source:
git clone https://github.com/facebookresearch/torchsnapshot
cd torchsnapshot
pip install -r requirements.txt
python setup.py install
Concepts
- Stateful object - an object that whose state can be obtained via
.state_dict()and restored via.load_state_dict(). Most PyTorch components (e.g.Module,Optimizer,LRScheduler) already implement this protocol. - App state - the application state described using multiple stateful objects.
- Snapshot - the persisted app state.
Basic Usage
Describing the application state with multiple stateful objects:
app_state = {"model": model, "optimizer": optimizer}
Taking a snapshot of the application state:
from torchsnapshot import Snapshot
# File System
snapshot = Snapshot.take(path="/foo/bar/baz", app_state=app_state)
# S3
snapshot = Snapshot.take(path="s3://foo/bar", app_state=app_state)
# Google Cloud Storage
snapshot = Snapshot.take(path="gcs://foo/bar", app_state=app_state)
Referencing an existing snapshot:
snapshot = Snapshot(path="foo/bar/baz")
Restoring the application state from a snapshot:
snapshot.restore(app_state=app_state)
See the example directory for more examples.
License
torchsnapshot is BSD licensed, as found in the LICENSE file.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for torchsnapshot-nightly-2022.9.13.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb78b15272194cae5674dae9ec8d48fe3e4f0b09ec7117c52bb262c245c76c72 |
|
| MD5 | d573feaab697077eaa9ff7e852bef53b |
|
| BLAKE2b-256 | 8713c1c2f2d078a0649674b605ebbf5de35150b4180de5a88933a54206960444 |
Hashes for torchsnapshot_nightly-2022.9.13-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 39e3ea026ee6120307662ba0669e844496b4b3a63357649717f780a3a447db72 |
|
| MD5 | 57d1b97cc3f9a82e5e60855f195576eb |
|
| BLAKE2b-256 | 4e9c40e14ed74446309e8a8720579da9a3007774fc1a17df08610815abbd670f |
