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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2024.1.8-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for torchsnapshot-nightly-2024.1.8.tar.gz
Algorithm Hash digest
SHA256 5830441722b7ef8915f49d86330d7a37062f1f2af46ccff8a3af83285432e7c1
MD5 0bf6007e1b3c636b7979d71d48afe596
BLAKE2b-256 963411d343b6ae5028cb59f7c7eff45a77627fb289a8264ab9ea152e00a381a1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9f51bd12fdd585d9ef158c510dbc9c50f89da334fa3deba9d9cc74b656008567
MD5 658b9cc7129c355525d63e6ad8424956
BLAKE2b-256 0e7e04ed3b1db577e0f24167e6e6bdbafe8897f28bbe956f3ee4db02f4ef0471

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