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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.24.tar.gz
Algorithm Hash digest
SHA256 4a21de060bbad2b623414ad008f302dda1b189ebcc315c8e6980031794bf2c3c
MD5 347c7740cec120df73c3637c8e0940ea
BLAKE2b-256 0c5a9ee6c2037e60b1f20520f12a1e3a0b28add29721acf50f48f6bc690871ea

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.24-py3-none-any.whl
Algorithm Hash digest
SHA256 3a15830882e772d4036656776a4d9471d205cb954cd3d2c8934173c050999daa
MD5 e93828b289ad9ad5644212e449aa8d27
BLAKE2b-256 9936acdef88cf6f8aded72a114ca8dbdb171d80ca673e19b62746f6c98316b9a

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