Lightning-AI/pytorch-lightning

Update deepspeed activation checkpointing docs

Open

#17,621 opened on 2023年5月12日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (26,687 stars) (3,233 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.