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.7.30.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a660bcbf8416d63bd1c6469196e0577d71d43dfe1b81e6a58b5fdfb009677295 |
|
| MD5 | baf7868fb6ea218989cea6c2e675dab0 |
|
| BLAKE2b-256 | 23a8bfc8153b6b4e077c1aea8a4eff5572007f2517cf2d4c82df37a557b5395f |
Hashes for torchsnapshot_nightly-2022.7.30-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e0d03ec0e10476de6d3538d5da2f11c5a324a705bdecda1480662bca19876e62 |
|
| MD5 | 31a1abf4ff0fd6b860bb2a698b14d685 |
|
| BLAKE2b-256 | d0c05a2ca59021adc7010807809a0061df447aa4fd80e5a64e3e7c1de906c031 |
