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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.7.20.tar.gz
Algorithm Hash digest
SHA256 0cee848db04d359719f6cb4bef37037ccd672e330627aee497fbde66a6ae27c6
MD5 0641a032fe5cfdb51248faaa2daa0c8a
BLAKE2b-256 0fd3c124fc4a24205996f905aca448eaf1255fb6142129cea8a349057aa458ff

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.7.20-py3-none-any.whl
Algorithm Hash digest
SHA256 095f14c4c9a727af5083200f65cad4d7ba54cfe3b49593fd904d1c26df3ea73a
MD5 fac79ff9a6b4a3936321cf3ad1f1508f
BLAKE2b-256 8fdade987f6ac6405ca1d6db112ddf7faa75d950bd1f4cc5975854b91a6eb5a0

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