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 torchsnapshot
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 Distributions
Built Distributions
Hashes for torchsnapshot_nightly-2022.6.16a2-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b652e4079740bb7544e5781e45292d2cd61af3a84ec4691b8f7a0a375ff8af3e |
|
MD5 | 1b2874827fb00ae7464b7bb947b9e8cb |
|
BLAKE2b-256 | 471636e0ae12fd201a35039fa120fce99040e265a2f44af81d6893b8f55eefd1 |
Hashes for torchsnapshot_nightly-2022.6.16a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87e13c19a1ab573a1b324d888bed90e1173afadf156d0e88245c0b5470fae9f5 |
|
MD5 | a9faa4ce5ebc70aebbe8cc3cdf9db75a |
|
BLAKE2b-256 | 9b7a444e05e08c1ea3b4c19e9f5aa40f7d54980cf4146c2222f470b8e502086f |