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.
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.5.25.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | adc243948280f799703ed87bdaa063863e805fe860e88b8d652fe4616db7f793 |
|
| MD5 | bd96945ba783a89e677e665e5e7d3816 |
|
| BLAKE2b-256 | 8f7b871db36afceeb159e643a5d769195fab19ef384ff34925c1149f0eaa34ec |
Close
Hashes for torchsnapshot_nightly-2024.5.25-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 504012e928e1add93693d7a3db27bd1c95206d7784c02c40e692b6056f3f1e17 |
|
| MD5 | 5b2fd5fb3632f5a83c0a23995ae5495a |
|
| BLAKE2b-256 | 5418043162641c9b7a075dba1d24fc4356406713f3658b4d3e3f485060a78dc9 |
