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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2023.11.18-py3-none-any.whl (83.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.11.18.tar.gz
Algorithm Hash digest
SHA256 3e985057bb957022650efa0fb927a0addf4d368972c5d974751c5e4a7fde31cb
MD5 1ac9ffca772c956f27bc937e3d46ee0a
BLAKE2b-256 fbbfb82dd44be6776d68776793845a371b6872f4ed701339e5746650c8377365

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.11.18-py3-none-any.whl
Algorithm Hash digest
SHA256 a01446b9ac7d6e5d31bba2e2926effb8650083f5dbfb35b01dcdd561f00035f5
MD5 9cf71ec60dd806285c447194c3352d1e
BLAKE2b-256 280d6ce1d4565345199c252a3cbe115e5bd8d33e26377c5e76b35a6760cc658b

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