feat(types): add type hints to public comm API functions#8118
Open
NovusEdge wants to merge 1 commit into
Open
Conversation
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>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
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 GitHub
Codex 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".
tohtana
requested changes
Jul 9, 2026
tohtana
left a comment
tohtana
left a comment
Collaborator
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?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
First pass at adding type hints to the public API in
deepspeed.comm:DFunctions typed:
init_distributed()is_initialized()destroy_process_group()get_world_size()get_rank()get_local_rank()get_global_rank()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