Lightning-AI/pytorch-lightning

Update deepspeed activation checkpointing docs

Open

#17,621 建立於 2023年5月12日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Python (26,687 star) (3,233 fork)batch import
docshelp wantedstrategy: deepspeed

描述

📚 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

貢獻者指南

技術棧
pythonpytorch
領域
documentationmachine learning
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PyTorch LightningDeepSpeed basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
First, verify the correct DeepSpeed activation checkpointing function by checking DeepSpeed documentation or source code. The issue reports that `deepspeed.checkpointing.checkpoint` does not exist. Update the docs to reference the correct function. Then, add a practical example using a pretrained transformer model (e.g., GPT 2 from Hugging Face transformers) to demonstrate wrapping only specific layers rather than the whole model. The example should clarify what to wrap when no custom layers are added.