Lightning-AI / Lightning-AI/pytorch-lightning
Update deepspeed activation checkpointing docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
In your [documentation](https://lightning.ai/docs/pytorch/stable/advanced/model_parallel.html#deepspeed-activation-checkpointing), you refer to the function `deepspeed.checkpointing.checkpoint`, but it looks like it does not exist (anymore?). Can you update that section?
While we're at it, can you provide a more common use-case as an example? The guide warns against wrapping an entire model, but having a pretrained language model from `transformers` is probably the most common use case. What if someone is just using GPT-2 or T5 with no further mathematical layers? What should get wrapped then?
cc @borda @awaelchli
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked DeepSpeed activation checkpointing section in the documentation and verify whether deepspeed.checkpointing.checkpoint still exists. Compare the guidance with common GPT-2 and T5 usage, then update the section so the API reference and wrapping recommendation are accurate for those cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100