Lightning-AI/pytorch-lightning

Update deepspeed activation checkpointing docs

Open

#17,621 opened on May 12, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (3,233 forks)batch import
docshelp wantedstrategy: deepspeed

Repository metrics

Stars
 (26,687 stars)
PR merge metrics
 (Avg merge 9d 15h) (3 merged PRs in 30d)

Description

📚 Documentation

In your documentation, 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

Research direction
Investigate the current documentation page, find the correct DeepSpeed checkpointing function name, and update the reference. Research how to wrap a pretrained transformers model (e.g., GPT 2) for activation checkpointing and add a practical example.
Tech stack
python
Domain
machine learning
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65