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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.17-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.17.tar.gz
Algorithm Hash digest
SHA256 eb3bf710d2deb68d92a4e793da1d141d46f0e86bbadda010d6798882abdd9abf
MD5 60aa40d2ed065c58538ec5dcd8828c6b
BLAKE2b-256 0b25046ce73ff210ab84032188944251d4525409de9fc929a35924510739f979

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.17-py3-none-any.whl
Algorithm Hash digest
SHA256 21cb12b0af79da99cc65279994ff5bd82cfa4441966f29e9dd9d4c6c2ffb8f2f
MD5 d02810efca793337ff0830692a308163
BLAKE2b-256 dffe44dce0bd430894eafe7eac556f5315914b28a7dba0a30f22746d8a41a4bf

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