Skip to main content

A library for persisting PyTorch program state

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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.6.18-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.6.18.tar.gz
Algorithm Hash digest
SHA256 aca63bbe8660b6ec37052c524b2eb7b75d04e57249dde3c6cc7e0ce035f9b6e2
MD5 2d111f9a3a3f6d77868e550fd2f76b5f
BLAKE2b-256 dee53b7b1be0447f5e1a848e12851e0cde2b13483d04de9217815b0e508becdd

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.6.18-py3-none-any.whl
Algorithm Hash digest
SHA256 83713cccb2ec5d8239078e6ecb05a2d8d794f8c77e42de936701b641bbe123ec
MD5 93a56a7a6c29f501fc0ba2188b592b70
BLAKE2b-256 4933577be0204d6a5af3ed864f50b2311bf3904bff41c5e939609d4ef8519733

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