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.
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.8.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 391e89fcfe936b38ebe19867bf0ad70aa3bd90447c7be362fffa8f8d1ec1bd00 |
|
MD5 | a44c9d484064e45089a03088d7e15d68 |
|
BLAKE2b-256 | cd7a3aabb1ffd650352d139d000a2a2624ca8907f84036314f651341660f1692 |
Hashes for torchsnapshot_nightly-2022.8.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01f68405aab7898239cf7ab779222271aac7a062cb2fb24e2bf02ccb11ea50a0 |
|
MD5 | b0a706525e95498912e8902ff5fb7589 |
|
BLAKE2b-256 | b22f9a5366c36dc770baf938bdb4e4a8dfe776c20fa36c4478c72102abef6679 |