Skip to content

docs(moe): Update MoE README#3664

Merged
yaox12 merged 3 commits intoNVIDIA:mainfrom
sbhavani:docs/moe-readme-stack-wording
Apr 13, 2026
Merged

docs(moe): Update MoE README#3664
yaox12 merged 3 commits intoNVIDIA:mainfrom
sbhavani:docs/moe-readme-stack-wording

Conversation

@sbhavani
Copy link
Copy Markdown
Contributor

@sbhavani sbhavani commented Mar 3, 2026

What does this PR do ?

Clarify Megatron MoE within Megatron Core and fix minor errors in README.

⚠️ For major changes (either in lines of code or in its impact), please make sure to first share a design doc with the team. If you're unsure what's the best way to do so, contact the @mcore-oncall.

Contribution process

flowchart LR
    A[Pre-checks] --> B[PR Tests]
    subgraph Code Review/Approval
        C1[Expert Review] --> C2[Final Review]
    end
    B --> C1
    C2 --> D[Merge]
Loading

Pre-checks

  • I want this PR in a versioned release and have added the appropriate Milestone (e.g., Core 0.8)
  • I have added relevant unit tests
  • I have added relevant functional tests
  • I have added proper typing to my code Typing guidelines
  • I have added relevant documentation
  • I have run the autoformatter.sh on my PR

Code review

The following process is enforced via the CODEOWNERS file for changes into megatron/core. For changes outside of megatron/core, it is up to the PR author whether or not to tag the Final Reviewer team.

For MRs into `main` branch

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!

(Step 1): Add PR label Expert Review

(Step 2): Collect the expert reviewers reviews

  1. Attach the Expert Review label when your PR is ready for review.
  2. GitHub auto-assigns expert reviewers based on your changes. They will get notified and pick up your PR soon.

⚠️ Only proceed to the next step once all reviewers have approved, merge-conflict are resolved and the CI is passing.
Final Review might get declined if these requirements are not fulfilled.

(Step 3): Final Review

  1. Add Final Review label
  2. GitHub auto-assigns final reviewers based on your changes. They will get notified and pick up your PR soon.

(Optional Step 4): Cherry-pick into release branch

If this PR also needs to be merged into core_r* release branches, after this PR has been merged, select Cherry-pick to open a new PR into the release branch.

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.com or zijiey@nvidia.com.

Merging your PR

Any member of core-adlr and core-nemo will be able to merge your PR.

@sbhavani sbhavani requested review from a team as code owners March 3, 2026 01:49
@sbhavani sbhavani added Expert Review [deprecated] Apply this label to indicate that your PR is ready for expert review. docs-only documentation only (docs or docstrings) labels Mar 3, 2026
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented Mar 3, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@svcnvidia-nemo-ci svcnvidia-nemo-ci requested a review from a team March 3, 2026 01:49
@yaox12 yaox12 added Final Review PR is in the "final review" stage and removed Expert Review [deprecated] Apply this label to indicate that your PR is ready for expert review. labels Mar 3, 2026
Signed-off-by: Santosh Bhavani <santosh.bhavani@live.com>
Signed-off-by: Santosh Bhavani <santosh.bhavani@live.com>
@sbhavani sbhavani force-pushed the docs/moe-readme-stack-wording branch from 5c7fcee to 2c320bf Compare March 24, 2026 04:12
@svcnvidia-nemo-ci svcnvidia-nemo-ci added Approved All necessary approvals have been made and removed Final Review PR is in the "final review" stage labels Apr 12, 2026
@yaox12 yaox12 enabled auto-merge April 13, 2026 00:58
@yaox12
Copy link
Copy Markdown
Member

yaox12 commented Apr 13, 2026

/ok to test af632b4

@svcnvidia-nemo-ci svcnvidia-nemo-ci added this to the Core 0.16 milestone Apr 13, 2026
@yaox12 yaox12 added this pull request to the merge queue Apr 13, 2026
@svcnvidia-nemo-ci
Copy link
Copy Markdown

🔄 Merge queue validation started!

You can track the progress here: https://github.com/NVIDIA/Megatron-LM/actions/runs/24320923105

@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 13, 2026
@yaox12 yaox12 added this pull request to the merge queue Apr 13, 2026
@svcnvidia-nemo-ci
Copy link
Copy Markdown

🔄 Merge queue validation started!

You can track the progress here: https://github.com/NVIDIA/Megatron-LM/actions/runs/24322555229

Merged via the queue into NVIDIA:main with commit 41fcaa4 Apr 13, 2026
42 checks passed
@sbhavani sbhavani deleted the docs/moe-readme-stack-wording branch April 13, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved All necessary approvals have been made docs-only documentation only (docs or docstrings)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants