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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.12.4.tar.gz
Algorithm Hash digest
SHA256 fe22c7bbe2b40d2bd7932101fe6ac5c29134264ff88920e40de2d02434e6cb68
MD5 3a8de1bad2614e7d2ef3a527dccd993e
BLAKE2b-256 14fd13967b6b7841d2cd31e9514d99191866c2efd73b1f84a886f0cff22dc129

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.12.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bc78c62e46b94fe1a1d89f7a16625c8b38378c8d4808823d3c196706599227ef
MD5 b8e063e200bbbd0bf537e8422ddac4ce
BLAKE2b-256 ec56be38e816d8b744ed1b060fee31183292515efe385addcc97d8b52e400704

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