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(app_state=app_state, "/path/to/snapshot")
# 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
Hashes for torchsnapshot-nightly-2022.10.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eace96fe16b9c2eccc53324544da1381364b419fa8066738aefc28ea2cfa477 |
|
MD5 | 0951cdcea7970bc7779c9be81a3c3742 |
|
BLAKE2b-256 | 50f189c474181fd3c5d20f44f340a3c7c39a13edeffea534121ea696f9478ba8 |
Hashes for torchsnapshot_nightly-2022.10.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b5a89b9cb942bc4feb3732b81b5afb5a9520cb074b35a5456f53a5606cbd25a |
|
MD5 | df50a37ad73cc253e4f01279a277d528 |
|
BLAKE2b-256 | b9a76ffca4db8ae4ab47207418515edaaa5962f53955733c84ecc4ebc02ddcff |