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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.8.8-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.8.8.tar.gz
Algorithm Hash digest
SHA256 19ef6120dd276b4fd1c40fc800299b671c2ab9d4de316eb850ea16bda467d949
MD5 990c9cdfc6cf005eccda03373c6c4153
BLAKE2b-256 dc54e98e1366e56e253253345b188f5664f6004b11283160f796e33f66a27a9a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e71bbc1d2fa1aee2faa24f75fcff6f2c183fbc3ab7e42235b3356da9f55a6f8b
MD5 17b7de8261d834576d2587d8dd4ad00a
BLAKE2b-256 69856fc08eeb7d689397294954d269a6f4b3df754a717d38fa6c939a2cd4fb98

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