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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.27-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.27.tar.gz
Algorithm Hash digest
SHA256 a6be1293e15c444f31614f486b09b76b5fa65573117a3ba1b93d33eade396108
MD5 b67793f9e00ef31548c5c715219c4a25
BLAKE2b-256 207ba9f8ea73a552edd76b9e501963832efc39dd770b3bf3ed763878ebeffd0d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.27-py3-none-any.whl
Algorithm Hash digest
SHA256 db6e105f67581f5aa2d8353ec6bd5f29e292a5e4da33a1d914aef4ec31cf6f2a
MD5 c6cd164717affab854397660a3bb6ae6
BLAKE2b-256 c59dbd2f315187e2a40540edbe0e31d57950412a30cd072eacb3e6c2102b038e

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