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.29a0.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file torchsnapshot-nightly-2022.7.29a0.tar.gz.

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.29a0.tar.gz
Algorithm Hash digest
SHA256 ba9121d74a15ab08c4259949e69191120b2fd1dadc54224ccac31c618e2e6c54
MD5 8f07fe1ca5bf053c70970449f3e0f711
BLAKE2b-256 1431a8ee3634b33ab70cb24a3a397c6111a4353e807dc709dc207c23eaef442f

See more details on using hashes here.

Provenance

File details

Details for the file torchsnapshot_nightly-2022.7.29a0-py3-none-any.whl.

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.29a0-py3-none-any.whl
Algorithm Hash digest
SHA256 9164e796d93ec395afcb193e580a9ea9d63e6403039c1142a465a43caddb8ab5
MD5 72cbc4578e81baa64d86c8c8cf995966
BLAKE2b-256 e6039bb0d0735a9e1f4b9969e145dfd1751825cd919c4e00c876c867e1764e1e

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