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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.8.30-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.8.30.tar.gz
Algorithm Hash digest
SHA256 686df3fa80f842409688f77600b955b39d01842d9c4841b70a028153ea5f0a57
MD5 0aea29869a76c7847cd807be47f44b6a
BLAKE2b-256 3052a7fad331c70849af1970bfabc51399b5d4b3505637354bb376f3c56a7821

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.8.30-py3-none-any.whl
Algorithm Hash digest
SHA256 a085550ffba1dc742417485f4651a190b52f17ee0409c7fb6cbfe7a3e6779899
MD5 d9073387fa2b9dd9cf388b351f62bb78
BLAKE2b-256 187c35473b244ba6a1e127570a7cc4a0e474c0073ee3e15251ae27cbdfa6afd6

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