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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.10.3.tar.gz
Algorithm Hash digest
SHA256 3355d9aac3d36f272c74dd5983007a634faf8ffa708ca5a710369d12c8996150
MD5 a21cc105b3f333d99733e6d09c504ad6
BLAKE2b-256 73f3b3ebfd07b3f5fa574150410279b1f22668959839f4c03a77b26fd3fac713

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1799fe11605d3ef3f86ed60c23eaa2afa93f07da53768ad02e7fb6390d55c357
MD5 039463c03c2a745c8314dd3e06385da1
BLAKE2b-256 c73c26b972d36f4aa1ce8ad17c0785573749df51f08d15342986550f621f2373

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