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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.28-py3-none-any.whl (45.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.28.tar.gz
Algorithm Hash digest
SHA256 66ad3abce33119591863a57f30f511e687cc296b1c04282ee57fd6809f52aca9
MD5 742c57cf728acc289d817f170aacf740
BLAKE2b-256 af5b4c67c40baadd97bb08b4d01f9226d7ddaad2c800cc9c24877ad10dd3e734

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.28-py3-none-any.whl
Algorithm Hash digest
SHA256 8eadc4c48ae09bf65bb9352c71bd28a25df56780a80cc0d0967b7a2202d7f621
MD5 6ecd75ae2c5d887bad20a1d2c7504c43
BLAKE2b-256 72acba5335dceee212d775da1aa5415ca941149e4b432f5acbceba675158ecd6

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