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.
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.18.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4bf0999e40696948cb5b790b1e8fd5440c256a56604a3eae7812eaabdad0dcbf |
|
| MD5 | 61dfd6c7f610f217f2b67383641b52a3 |
|
| BLAKE2b-256 | 8a567df9bd21ea9812ea854fec4fa1bee3a1ecc83ea631c06c00facbd38171e4 |
Hashes for torchsnapshot_nightly-2022.10.18-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5fe6316c5476872c655ccbde5d238ace6b020d2d5c9b523044e54334f4e5853 |
|
| MD5 | 22600c6367682c48794bc3bba2d2853a |
|
| BLAKE2b-256 | 3400b0ed462267722a2af60159113cec0411440a8becaf560b2cc5683c197957 |
