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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.26.tar.gz
Algorithm Hash digest
SHA256 d049f78f84681aeb8cb7d76039d377b353bf3f6255545be4e99a7292793ae967
MD5 3bb4964c008c641a1c786293708d6789
BLAKE2b-256 2c4e9e53898de6af7a6e205581306fee00dc806808e6e3f8dd271fd190f44bf4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.26-py3-none-any.whl
Algorithm Hash digest
SHA256 96cc2dc3eeda1e7237de6185016936e4e2b39d6cd471347ea0e01afb7f59a334
MD5 312035269d825c3622b9e7cf983531b4
BLAKE2b-256 8099134d98861c4398c7afdb0f9378d8891e1f0daea580fb421f0c5efad4bf87

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