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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.24-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.24.tar.gz
Algorithm Hash digest
SHA256 785bdc4a236daa6857020cf32d22a05d367457fc4cfd52482462a64f88870f5f
MD5 7a03a8c85c9cb48096ac9129a2377104
BLAKE2b-256 69c6bd1494e63c92ace2c462469f5d8d383bc19d88e9824f4356a4c3a6eb0284

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.24-py3-none-any.whl
Algorithm Hash digest
SHA256 e50e99be5abaf6888e7d22b2acb5897e1ee2d2e901a15ee20a25e1f88808a751
MD5 115990fbbd4ac93f0c6a063478ca8530
BLAKE2b-256 4b8b767dfa55e7bea219e8a92c5fb4fb6e97f784f4b92944f8863dea8ca68129

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