Lightning-AI / Lightning-AI/pytorch-lightning

Add `CheckpointIO` classes to split checkpoints

Open
#12,712 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design feature io
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

## 🚀 Feature

Create new `CheckpointIO` classes that allow:
- Splitting a checkpoint by keys, enabling #5339
- Splitting a checkpoint by size, relaxing the memory and storage constraints

### Motivation

See existing discussions in https://github.com/huggingface/transformers/issues/13548 for why these are interesting features to end-users.

### Pitch

`Trainer(plugins=CheckpointKeySplitterIO())` or `Trainer(plugins=CheckpointSizeSplitterIO(max_size="10GB"))`

### Alternatives

Have users create and maintain these solutions. The `Trainer` should allow it.

______________________________________________________________________

#### If you enjoy Lightning, check out our other projects! ⚡

- [**Metrics**](https://github.com/PyTorchLightning/metrics): Machine learning metrics for distributed, scalable PyTorch applications.

- [**Lite**](https://pytorch-lightning.readthedocs.io/en/latest/starter/lightning_lite.html): enables pure PyTorch users to scale their existing code on any kind of device while retaining full control over their own loops and optimization logic.

- [**Flash**](https://github.com/PyTorchLightning/lightning-flash): The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, fine-tuning, and solving problems with deep learning.

- [**Bolts**](https://github.com/PyTorchLightning/lightning-bolts): Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.

- [**Lightning Transformers**](https://github.com/PyTorchLightning/lightning-transformers): Flexible interface for high-performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

cc @borda @tchaton @justusschock @awaelchli @jjenniferdai @rohitgr7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Trainer plugin entry point and review the linked discussion in issue #13548 for the intended use cases. Define the CheckpointIO interfaces for splitting checkpoints by keys and by size, then make the proposed Trainer plugin configurations work and verify that both splitting modes meet their stated goals.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
machine-learning
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.