deepspeedai / deepspeedai/DeepSpeed
[zero3] new API docs?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 43.1k
- Forks
- 5k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 112
Description
Would it be possible to document the new API?
I found:
deepspeed.zero_optimization()
which I think tells me if zero is enabled or not.
deepspeed.zero_optimization_stage()
is what I really needed to know to write conditional code for zero2 vs zero3.
Fished those out from dir(deepspeed) ;)
If there is no time to do full docs, at least having a full list of what is considered a public API would be a great start.
I see most of them are sort of properties of the config object, so I'm not sure how safe these are to use in user code.
Thank you!
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 by inspecting the public behavior of deepspeed.zero_optimization() and deepspeed.zero_optimization_stage(), along with the config properties mentioned in the issue. Define which APIs are supported for user code, document how they distinguish ZeRO stage 2 from stage 3, and provide a complete public API list if feasible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100