Refactor BackendSpecProvider to use Protocols to define the types it returns#4087
Open
nschank wants to merge 6 commits intoNVIDIA:mainfrom
Open
Refactor BackendSpecProvider to use Protocols to define the types it returns#4087nschank wants to merge 6 commits intoNVIDIA:mainfrom
nschank wants to merge 6 commits intoNVIDIA:mainfrom
Conversation
6 tasks
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
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.
What does this PR do ?
Some relevant discussion in #3434 - basically,
BackendSpecProvideris accidentally obfuscating the types right now, stunting the effectiveness of the otherProtocolupdates. By havingBackendSpecProvideractually specify the interfaces that must be honored by subclasses, the spec types all work together nicely.Associated design doc: Typed ModuleSpec.pdf
Notes:
@overloadand@finalhelp ensure that the type checker will force the subclass to properly implement the interface.BackendSpecProvidersubclass ensures that the return types actually honor the interface thatBackendSpecProviderspecified.boolmethod, since you can just use anis Nonecheck (and that's easier to type check too).linearto all spec providers to make it consistent; sinceLocalSpecProviderdidn't have one already I defaulted toNotYetImplemented.Contribution process
Pre-checks
Code review
Feel free to message or comment the @mcore-oncall to help accelerate your merge into main. The less complex your PR is, the faster it will be approved and merged!
All PRs start as draft. If you open a non-draft PR, it will be automatically converted to draft.
Step 1: Mark PR as "Ready for Review"
.github/CODEOWNERS.Final Review might get declined if these requirements are not fulfilled.
Step 2: Final Review
For PRs that change
megatron/core, once all expert reviewers have approved, theFinal Reviewlabel is applied automatically and final reviewers are assigned.For PRs outside
megatron/core, this step is skipped.Step 3: Approved
Once all required reviewers have approved, the
Approvedlabel is applied automatically.Merge
Any member of mcore-engineers will be able to merge your PR.
For MRs into `dev` branch
The proposed review process for `dev` branch is under active discussion.MRs are mergable after one approval by either
eharper@nvidia.comorzijiey@nvidia.com.