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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.11-py3-none-any.whl (50.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.11.tar.gz
Algorithm Hash digest
SHA256 dd1b0491a5d1f6eadac010451fe8b54c86707a58821579f4dfddac4d3580d5cf
MD5 490a6cfd79a1ec10e26fb1d8121a9e99
BLAKE2b-256 3022aee37e6f1ae1acbc461aeca11b2e3891ae0953f74142afdd5eaeea026418

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.11-py3-none-any.whl
Algorithm Hash digest
SHA256 aae564f12d1e73c3ef2994895b59a7e21b10c27c003adef534e552e1391a20b0
MD5 dd776a459f5efd4b2715e43f57b6b563
BLAKE2b-256 a203604118474d22ad7eefc5fe689531c2b7afb8bb13dc2c874918d7ad997c76

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