Lightning-AI / Lightning-AI/pytorch-lightning

Update deepspeed activation checkpointing docs

Open
#17,621 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs help wanted strategy: deepspeed
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

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.