Skip to main content

A performant, memory-efficient checkpointing library for PyTorch applications, designed with large, complex distributed workloads in mind.

Project description

TorchSnapshot (Beta Release)

build status pypi version pypi nightly version codecov bsd license

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

# 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

torchsnapshot-nightly-2023.2.4.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

torchsnapshot_nightly-2023.2.4-py3-none-any.whl (68.7 kB view details)

Uploaded Python 3

File details

Details for the file torchsnapshot-nightly-2023.2.4.tar.gz.

File metadata

File hashes

Hashes for torchsnapshot-nightly-2023.2.4.tar.gz
Algorithm Hash digest
SHA256 8e6a452b30ba0b152d5906f14ceab86eee0056e535dbade6fa82bced6b786053
MD5 5e33d14c8ff5351ddad46aade1275f10
BLAKE2b-256 4577c846332a554ec72404aea0d026d373690c2a794af2f7747234c467219205

See more details on using hashes here.

Provenance

File details

Details for the file torchsnapshot_nightly-2023.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for torchsnapshot_nightly-2023.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c3af12eead9a3d7b6f49b45ffd16896efea5057658899274389a130697bcee7f
MD5 201654ce3ffc11c197c29ef22422de56
BLAKE2b-256 3c3245d4903a6b77d8153a5fbf175aa448a24f95a940387e1c76f5a145dc7b00

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page