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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.25-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.25.tar.gz
Algorithm Hash digest
SHA256 ad2e26d43798be9da2234f65bb3ad8ea9df387852c6d96511a4ffa984adddf2c
MD5 fecf62f7b4efd36907711d7ab57259f4
BLAKE2b-256 ab1af7bd2586515e040a03d655bca87e37d8dfc6a5d6c81c6a70130a3ed2ebf4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.25-py3-none-any.whl
Algorithm Hash digest
SHA256 f29b44561feea192c34b59c6311ab6ab2b8e5b72afb0914743d36eb94c0d17b3
MD5 e40befb344e7942ea605c483254b4ae8
BLAKE2b-256 a42381374dbda88566a86cf4879adc0423c70ff0489f45ae6f8ccd7ba1cc3d13

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