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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.10.8.tar.gz
Algorithm Hash digest
SHA256 c150af5589a4c3d3f70afa39458c4baec9fc8b3c904f10712e4b5bd2b6c4671c
MD5 46573808069b89bff388a92a0bf52766
BLAKE2b-256 cb244c97f2b2dd1ae162acb6458f5b5df9b4459aa3c4d82ea4d857b5fd8c89d1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.10.8-py3-none-any.whl
Algorithm Hash digest
SHA256 591ef9a5b2bbb1da9761568b64b06d046641e5c62bd7ba49e9cccea20fa83d87
MD5 a0885e2eea55784a5122a229508ebba9
BLAKE2b-256 9c52fc3a4283c090b760742a1c460c0fd921572f18397e3b02cede1ed3afed50

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