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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.9.14-py3-none-any.whl (50.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.9.14.tar.gz
Algorithm Hash digest
SHA256 5805672cae2b26f48f9a41c8ce9285d54446ae57f4e2fb32b0bbb6ec5d255cdf
MD5 67506490947762b3a6bbb054a782d1cf
BLAKE2b-256 6f8da5b4a03418562bc3092b34b606927a8df2079394e3d1734ad649bc86c929

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.9.14-py3-none-any.whl
Algorithm Hash digest
SHA256 c9c4da4325b4accdfda3ff57111518157c34768f1c31d72c47b6446c167e1c37
MD5 b98f53620851520dc67cb5d1053a8904
BLAKE2b-256 4848e7b187cf9cc8da78ba102f5662757cb86bc6879cdd2bbf584b68fab754c9

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