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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.30-py3-none-any.whl (50.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.30.tar.gz
Algorithm Hash digest
SHA256 e63ef8ad539ec8820f4320f315f1f85c220de61d85032f3e6f8a2275c6d4c65a
MD5 88572e949de4b6b79c7970fa35be2bd5
BLAKE2b-256 8b9e7e4e19a8916ef54cc296efd31ee494c67706f6bb74499c4bce8a41f802b4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.30-py3-none-any.whl
Algorithm Hash digest
SHA256 d1d0ed60d075bb0e599ec795d119d95b2d0c82dc02a44f8e502cbd3006798894
MD5 4d4b615325bf183d10fbf415eaf1e52f
BLAKE2b-256 2df1faea6a4f5de2c67b0ebef0c06969438734405f828d7131523bd220314cef

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