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.8.26.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 72fcd8d56e22f26e93b953c1237753782e4db9b58c637dafb5c462c5edc7f94c |
|
| MD5 | bbae0afa332911df97f94bea4228237b |
|
| BLAKE2b-256 | 1ea14deb86f15589cd79ea346f8fcf235e5ec83f5e190d3e47861cbd470917ce |
Hashes for torchsnapshot_nightly-2022.8.26-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9419145fe81ff4dd53182ad972069b4a834ebd9fc00f2bce17f128c95e0c6071 |
|
| MD5 | 70026d5e6be0ca63605f84f94c9eb7da |
|
| BLAKE2b-256 | 9b62905fc001db3fcd900215cd3f8163c03c64cdd23c7e9f182ed734bcc98c93 |
