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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2024.6.15-py3-none-any.whl (84.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.6.15.tar.gz
Algorithm Hash digest
SHA256 105c79e10698d484463ed7f5488586adeb1c4fb8577fd0b3b14298ea8e019834
MD5 bbda8e3b5055017a9f7fe591cd9c0959
BLAKE2b-256 4d196bfa68093f1189d4669ff4b2433893e9ab0f1d0a88e7bcb0af98ec31c0ee

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.6.15-py3-none-any.whl
Algorithm Hash digest
SHA256 04c7f175d9b5902e1719b842990718d638b3e3974277e97b9f5f9b9efbe63565
MD5 899bc68ed9b8f6cec45084e65b4cc6f1
BLAKE2b-256 5379e5d75c329c7ea36d8f2a0d1cb6d00b5e323f362915095df400cc20e2d6bf

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