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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.17-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.17.tar.gz
Algorithm Hash digest
SHA256 e3f49c18086f53ede03a153bac62202580f4820667311874bcc0563366ade3a0
MD5 7333525e4041741d4706b0c8480b8c7c
BLAKE2b-256 f26e1c3a4d2ee20cbc09ade1e430a8c7c0a73ed777a148604e4508cf1b022a75

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9a3e1ea97638aae5a913d8a534b46e78b264f7c496e22b87b2b45a94a2aabe65
MD5 dfa840f7da477e6191c9c4f35384848e
BLAKE2b-256 bf8437471e8e5287c9ae2e8e98db823e71f9014cfb3132f3851fbf92efe70a07

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