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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.7.18-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.7.18.tar.gz
Algorithm Hash digest
SHA256 a9aea98101085022667a52c14fd31e17ebb2a150fa266ce3f97756b64f1f6bc8
MD5 f88294ca862bbbd9bf8cb0666dffe068
BLAKE2b-256 0581125a6d1ffc32ef41d5ad7508febe637dd8c8b10ff9fd65c227b94a7e3de0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.7.18-py3-none-any.whl
Algorithm Hash digest
SHA256 50f75f2202e97287aa6a469a8877fd282d320e6a6bb2d267df980d8bdab933d8
MD5 4374dd7058f7d87a67b78d422896b427
BLAKE2b-256 f674d80355c4bffb848801a243ef0443683ac2801812b8b82600b43d1bf1a5e5

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