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.7.9.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.9-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.9.tar.gz
Algorithm Hash digest
SHA256 e1afb8dd120c2796c612a838e67aa62360577e3b9ce8cf4a242f0caae72f99b6
MD5 5cac5578efbdc0e2fe761bec90f500fa
BLAKE2b-256 6581733900dc018704c6f1168507c93a29d3b3601fc1c6a042966511a96884d5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 04b7e57852643b27a75e78bfe86568095915cf7ce4c011020c4931d1c2e6f838
MD5 7a4ce13d180dfb442c4199535329b994
BLAKE2b-256 29b8ed50cc814b4b1640f775879fe67b5bb80bff46063a7e450b9a88d8f92895

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