feat(types): add type hints to public comm API functions - #8118
Conversation
Sorry, something went wrong.
Adds type hints to the most commonly used public API functions in deepspeed.comm: - init_distributed() - is_initialized() - destroy_process_group() - get_world_size() - get_rank() - get_local_rank() - get_global_rank() This is a first pass - more functions can be typed incrementally. Relates to deepspeedai#8074 Signed-off-by: NovusEdge <novusedge0@gmail.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7039a88198
ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Sorry, something went wrong.
tohtana
left a comment
There was a problem hiding this comment.
Hi @NovusEdge,
Thank you for submitting this PR! This is useful, but I think the comment from codex bot is reasonable. Can you address it?
Sorry, something went wrong.
The config parameter accepts a DeepSpeedConfig object (which has the .comms_config attribute), not a plain dict. Using Dict[str, Any] would cause AttributeError when configure() accesses config.comms_config. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: NovusEdge <novusedge0@gmail.com>
tohtana
left a comment
There was a problem hiding this comment.
Thank you for the fix, @NovusEdge!
Let's merge this PR.
Sorry, something went wrong.
Summary
First pass at adding type hints to the public API in deepspeed.comm :D
Functions typed:
Why
Better IDE autocomplete, mypy support, and easier onboarding for new contributors. Types are basically free documentation that doesnt go stale.
Notes
This is incremental — more functions can be typed in follow-up PRs. Started with the most commonly used ones.
Relates to #8074