A library for persisting PyTorch program state
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.6.20.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cfe3ddea9d8900d95aa5a79f4f4637cdb40bcc7df5941af05459a9ad5686821c |
|
| MD5 | 0676fbe141bf9be533578e21bca84d3d |
|
| BLAKE2b-256 | 562db565fe6c00d64e48774e4191a1d1861e306e45b92f34ef8be5613d8e8acd |
Hashes for torchsnapshot_nightly-2022.6.20-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dce059f2a80bac361f39def648684b5c87c77b31868db354ccd39089e70d8367 |
|
| MD5 | f1e228aa7e00091b36ddf0bb210f59ab |
|
| BLAKE2b-256 | f1b5e20c12835c6293c217f7dfe371755923fac58497fb0d052daf4053157091 |
