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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.6-py3-none-any.whl (49.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.6.tar.gz
Algorithm Hash digest
SHA256 62189ff1f1655b6024d663daef9eead9056b6c2ad5a81ef833c43da243d95a07
MD5 68423bb5ea7e9e503623270377733940
BLAKE2b-256 c409811e8eba6401cfd6a657aa987bc46e383934cc8e5a0bf701358f7cb2b21c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 70c445555480ddb526ecd50e464b2be6fabad358d5e06a3d25b85fafcbf057b3
MD5 802d8bd6dfa0377a9f12bf056edbd947
BLAKE2b-256 07d98b2fb6f27c706b13931fe8921c712ddeaa8ce6c68b2246178286b6b196bc

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