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

Uploaded Source

Built Distribution

torchsnapshot_nightly-2024.7.1-py3-none-any.whl (84.6 kB view details)

Uploaded Python 3

File details

Details for the file torchsnapshot_nightly-2024.7.1.tar.gz.

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.7.1.tar.gz
Algorithm Hash digest
SHA256 bd13a4206c5a3dffe5ef63db3721ef3a789993b9b3d1ef1b1c2e737ada86b008
MD5 31ad0ad4e813725893291b2269ba872a
BLAKE2b-256 985be76c55a419006e7babfcab55e1991b76c2856bf393c191cc1ce56a5224ab

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for torchsnapshot_nightly-2024.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ddc98eb36e29e5b44382341c288c309c195ac10850e85ef9aaae75267fa9aac1
MD5 191cb0b5405ca89c14765dee1a90e4dc
BLAKE2b-256 1a131a838f75d497148c0f1fea5c681ec203c4079f9121de8a875b99e211ea97

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