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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.6.24-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.6.24.tar.gz
Algorithm Hash digest
SHA256 3e7e783848e647ab6f01299f23fa6ef68c23162d694208a5b0899c31dcc8d5f8
MD5 a03b04b2d4f595145f74aa54f808f2b8
BLAKE2b-256 f847268991f664188fe1d081e1a6be133a7524466b3823cfa61d8c4bbd76a3e9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.6.24-py3-none-any.whl
Algorithm Hash digest
SHA256 bbb0ae85db558ac85e486f4dff9f162fede2179a3ff2121efe79e45a443b61a4
MD5 63c058163c7a15c1263903346d82d138
BLAKE2b-256 997e679693ace02cd5b53218546f77b75fc047ee6ea5a562848678e614d5241d

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