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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.12.1.tar.gz
Algorithm Hash digest
SHA256 81f855f6a9774c95e851374c7aaeccd7c0e941a6158d9801d447dc568378c49f
MD5 cfbf1b5b1126dfee9150d8b0f7fd02e2
BLAKE2b-256 0b445771668887db0ebb12bcd37ac3a73782198d7bb9be93e832bba9454e777b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c828d191821ad305816f55c3104350b17385c935e05b35c1a0d75684720cbf1
MD5 a5e1ddf025fee67069275b9eda19ed5a
BLAKE2b-256 7889fbbbfaf5a1c12ffb96dc3e536ba13f42d8f8f30e3b97bd4be9e6a7b4ef77

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