A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.
Project description
TorchSnapshot (Beta Release)
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
Built Distribution
Close
Hashes for torchsnapshot-nightly-2024.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1d323124fc49d4d85a5a48b298e15d13ac920803fef553bca3dd1411dc1e4b9 |
|
MD5 | 9d7c65f36089d105752f4d120e90427f |
|
BLAKE2b-256 | 3e82e04fb87ca59902b8d91ecf06b422f326493907fef80fce3c163e08edbe9e |
Close
Hashes for torchsnapshot_nightly-2024.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c46657bca15d088a3ec145d3c5e2e6ed618781217cf29093262072790c53640f |
|
MD5 | 7d4a700c3c935c9c3d4aa4967c427fc5 |
|
BLAKE2b-256 | aa655e69ccac2450501cee77e7571330c4517622bfd4b90b3ff9d951ed569e9d |