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.7 and PyTorch >= 1.12
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-2023.8.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2af9574bfe7c57cea2a96df7a8277fe8143f36868541d2e6486272594313faa0 |
|
MD5 | 259cf44efbf303a4bb9a9e1675e1a311 |
|
BLAKE2b-256 | 7c7703b53ed4c4cfa3485aa41327cf7164b3ef831b969d97af6fadaa16efbe0e |
Close
Hashes for torchsnapshot_nightly-2023.8.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 193cc55e3bf194cb30c9ee1a6561c8b4c2c29178d1f4a6c66e1bdfd1425f98e8 |
|
MD5 | ce165af6a92d0a7b2bf7ef6a10684d96 |
|
BLAKE2b-256 | bba0db5751e05b7bc2bab9b82ae099bc4f5f54a2de68b756b8a6170425821647 |