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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2023.9.22-py3-none-any.whl (72.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.9.22.tar.gz
Algorithm Hash digest
SHA256 2074fb3ca9e210f99b8891dff1e35b47db63125c517ac584daa33df4051b1f87
MD5 f5cdb306950ec6573181a57d869e8c5f
BLAKE2b-256 788ec14d31a2ee5d4631eb1a9006611322f8f1623febe1ff2a7bed00ac98ebc5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.9.22-py3-none-any.whl
Algorithm Hash digest
SHA256 5d9941c235ee53e8bc688d8743107ff5346d016ed5fb820d0c4499dbeea0ecd6
MD5 bbd1dfa3333e85e0098547a89d18192d
BLAKE2b-256 2c825d594110f0c92ba121a342f98520a36540ce5d32e6eb08322057f15fad70

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