Skip to main content

A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.

Project description

TorchSnapshot (Beta Release)

build status pypi version conda version pypi nightly version codecov bsd license

A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.

Install

Requires Python >= 3.7 and PyTorch >= 1.12

From pip:

# Stable
pip install torchsnapshot
# Or, using conda
conda install -c conda-forge torchsnapshot

# Nightly
pip install --pre torchsnapshot-nightly

From source:

git clone https://github.com/pytorch/torchsnapshot
cd torchsnapshot
pip install -r requirements.txt
python setup.py install

Why TorchSnapshot

Performance

  • TorchSnapshot provides a fast checkpointing implementation employing various optimizations, including zero-copy serialization for most tensor types, overlapped device-to-host copy and storage I/O, parallelized storage I/O.
  • TorchSnapshot greatly speeds up checkpointing for DistributedDataParallel workloads by distributing the write load across all ranks (benchmark).
  • When host memory is abundant, TorchSnapshot allows training to resume before all storage I/O completes, reducing the time blocked by checkpoint saving.

Memory Usage

  • TorchSnapshot's memory usage adapts to the host's available resources, greatly reducing the chance of out-of-memory issues when saving and loading checkpoints.
  • TorchSnapshot supports efficient random access to individual objects within a snapshot, even when the snapshot is stored in a cloud object storage.

Usability

  • Simple APIs that are consistent between distributed and non-distributed workloads.
  • Out of the box integration with commonly used cloud object storage systems.
  • Automatic resharding (elasticity) on world size change for supported workloads (more details).

Security

  • Secure tensor serialization without pickle dependency [WIP].

Getting Started

from torchsnapshot import Snapshot

# Taking a snapshot
app_state = {"model": model, "optimizer": optimizer}
snapshot = Snapshot.take(path="/path/to/snapshot", app_state=app_state)

# Restoring from a snapshot
snapshot.restore(app_state=app_state)

See the documentation for more details.

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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2023.9.7-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.9.7.tar.gz
Algorithm Hash digest
SHA256 0925eef766d707722fdb80b48ef9501d36d9902560b8a61cd920464dbe9d7528
MD5 37246e8d353f467d3cb02bc52cde8041
BLAKE2b-256 df97990f3d0e6f4e1588a14b6dadd07c8d38796c5bc3b3cda0eac2a033ad7ee0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a39117076b8fada52fb8bdf03effafd2cd751a3d1edb4ed57d8c06c39145b6c4
MD5 1350a5b4e8c4ca9f405bd662bb5d2ad3
BLAKE2b-256 65fda7d7794bc4a048319723344fcbe508914f2818d6e66fe5c00b321f3e1f00

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