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.
Project details
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.17a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42ac38f6eb7c7d76cd37282abd0f3894c69ab3ce67d3e65bc5b5985eb4418010 |
|
MD5 | 2c91114e9056a0d605549bc86e7e905d |
|
BLAKE2b-256 | 766198baa192ad8b9be188a5fe15d32549e52ab3503bef8689a1a4b0eb743b5c |
Hashes for torchsnapshot_nightly-2022.6.17a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b022cfa48d16836c06760341d0b264483a971d5b32e11cdb46d77212ef3ef641 |
|
MD5 | c61f37333e6ee919289334e9bb4b84f6 |
|
BLAKE2b-256 | b19d33a33e470dfe6ce47f421ca673483757f3cacc960c049234eee8e1e8e3ad |