A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.
Project description
torchsnapshot
This library is currently in Alpha and currently does not have a stable release. The API may change and may not be backward compatible. If you have suggestions for improvements, please open a GitHub issue. We'd love to hear your feedback.
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:
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
Hashes for torchsnapshot-nightly-2022.10.27.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7df102a8674e0b60a1644c42b2b718fd490a4d043d415d08d31f5f2a49078cfe |
|
| MD5 | 2aa8bb7f8ad2b6715ef2ca969f1297a5 |
|
| BLAKE2b-256 | 8ab25bd345ad3f8ee9907ead7a877e761fa917c9b9e5f82986c702d638bcf78a |
Hashes for torchsnapshot_nightly-2022.10.27-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b3f6532df6e4750d45536d3520619ce967de676ae93db253edeb68c5a51acb25 |
|
| MD5 | 3661b217ae26e00312f951ad58af513a |
|
| BLAKE2b-256 | fca1a0a6985d03a41183824717c6ce48396497afca54b43c85274d723e2ba8bb |
