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.8 and PyTorch >= 2.0.0

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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2024.5.21-py3-none-any.whl (84.7 kB view details)

Uploaded Python 3

File details

Details for the file torchsnapshot_nightly-2024.5.21.tar.gz.

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.5.21.tar.gz
Algorithm Hash digest
SHA256 6306a7964f8c35a41bd1a692bd6c8f93c54c94ad194a0c76b26e9abf7c616ace
MD5 f78f1c35a99eca64df9b2644c752a4c4
BLAKE2b-256 a23e9642ab33962cb93ae29936eb89a93f52c40f88233bd8d116e3ca1500b670

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.5.21-py3-none-any.whl
Algorithm Hash digest
SHA256 b29d25868599a4360b977825a7a966f1b4f6c4ce139db3f1946838c3e840a244
MD5 fa12e579c11adbc5b4dab718c612747d
BLAKE2b-256 7a172176158bfebae2a6e62162da32fcfc509854bbf1710016f16d15d7026aac

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