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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2022.8.10-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2022.8.10.tar.gz
Algorithm Hash digest
SHA256 3b19c47ba3a2ee89c3c8a075c3f197c55bf045c982c5e4a7852b8da96c0eea9b
MD5 4b512581a0d701557904bc325f7f63e4
BLAKE2b-256 be7467202be15ecf228cebc8e903a035372bc6aadaf5da2aab64a19e4bda5491

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2022.8.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a4c4c08652867673e4bf341c8b31cd55bba2c1a04e132878455ad406dea44000
MD5 384b185389a9eed2cf20ad352af84f65
BLAKE2b-256 3cde1a4206ac3fab09bcfd8480383faafa48e04f39a27ba0a54224ae16a24e10

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