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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.21.tar.gz
Algorithm Hash digest
SHA256 c712be4aa39777b0e501135a4306bacde16a89b222ce1dc5446f17c738c1a956
MD5 2b4010c04ff82d9a396ca4507d9ef6fd
BLAKE2b-256 ec5f318f2184212f5bd48f18eebc691385a4a4c75ed0f15396aee5ee0bc71779

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.21-py3-none-any.whl
Algorithm Hash digest
SHA256 3949f912aa68a79eb5029ae612e1c77c8ee81a1907960afca50a862da2563639
MD5 133c9859d1492ea849ab8ac94a11ceb1
BLAKE2b-256 2cdd7523c7ada32d1d345f60203da9cdb3187721e3c57a5d23002c02f9b7475f

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