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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.8.25-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.8.25.tar.gz
Algorithm Hash digest
SHA256 b15a51c13bff6db6f83713d37dbe87cf7c5a1fc02fb173c6ed25b435cb65c2d7
MD5 95b9d56635d0bd46cd648ad8f718c485
BLAKE2b-256 f130a74a4b212c3528474457638d98a85de4cee7d3547b96cbc52f61a2bd9b14

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.8.25-py3-none-any.whl
Algorithm Hash digest
SHA256 8af5d86d724ffdd3938075db87ddb942fdb64fa6e85fede6667329d35c591d2a
MD5 ae9b4547d70d6eb28269d03528f18e68
BLAKE2b-256 66cb423f330728263be881a7eee04ec5ba6fa8626a54002f22ad1172b0868843

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