Skip to main content

A lightweight library for adding fault tolerance to large-scale PyTorch distributed training workloads.

Project description

torchsnapshot

build status pypi version pypi nightly version codecov bsd license

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

torchsnapshot-nightly-2022.8.29.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.8.29-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file torchsnapshot-nightly-2022.8.29.tar.gz.

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.8.29.tar.gz
Algorithm Hash digest
SHA256 c65103cf8ad59d2501fe3e2a8d9756c12e92d0a450c170183bab6635528e47b3
MD5 a6a1768cd2bad075510a1c1298c83028
BLAKE2b-256 c461376640a1bca666171bfb243a8e87a46d0221dc7cce627e6ab15af5c3bb4a

See more details on using hashes here.

Provenance

File details

Details for the file torchsnapshot_nightly-2022.8.29-py3-none-any.whl.

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.8.29-py3-none-any.whl
Algorithm Hash digest
SHA256 71a9d31b3e64a08223db6a7f0529368786f47e5276d83b131ba9f743fdc37d4a
MD5 5812aabe667da6a3061c41e6df0db96b
BLAKE2b-256 1ca0883770d13bb7fcea6f4ec0f0f8151b7a1037b2dda6d5f579496cf3938c75

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page