Skip to content

Update readme#232

Merged
skyw merged 1 commit into
mainfrom
skyw/update_readme
Jun 23, 2026
Merged

Update readme#232
skyw merged 1 commit into
mainfrom
skyw/update_readme

Conversation

@skyw

@skyw skyw commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Update megatron integration and benchmark section.

Signed-off-by: Hao Wu <skyw@nvidia.com>
@skyw skyw requested a review from mkhona-nvidia June 23, 2026 17:01
@skyw skyw added the docs-only With great power comes great responsibility. label Jun 23, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

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.

@greptile-apps

greptile-apps Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates the README with two documentation improvements: the Megatron Core integration section now points to the stable core_v0.18.0 tag (instead of the dev branch) and describes newly available features, and the Benchmarks section replaces the "Coming soon" placeholder with a link to the NVIDIA developer blog.

  • The Megatron Core link is upgraded from the moving dev branch to the pinned core_v0.18.0 release, which is a more stable reference.
  • The Benchmarks section now links to a published blog post at developer.nvidia.com.

Confidence Score: 5/5

Documentation-only change with no code modifications; safe to merge.

Both changes are purely textual: one updates a GitHub link from a floating branch ref to a pinned release tag, and the other swaps a placeholder with a live blog URL. There is no logic, configuration, or runtime behavior involved.

No files require special attention.

Important Files Changed

Filename Overview
README.md Two documentation-only updates: Megatron Core integration link updated from dev branch to core_v0.18.0 tag with expanded description; Benchmarks section replaced "Coming soon" with a link to the NVIDIA developer blog post.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Emerging Optimizers\nNVIDIA-NeMo/Emerging-Optimizers] --> B[Muon / Shampoo / SOAP\nOptimizer Implementations]
    B --> C[Megatron Core Integration\nNVIDIA/Megatron-LM @ core_v0.18.0]
    C --> D[Tensor Parallel Support]
    C --> E[Split QKV Support]
    B --> F[Benchmarks Blog\ndeveloper.nvidia.com]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Emerging Optimizers\nNVIDIA-NeMo/Emerging-Optimizers] --> B[Muon / Shampoo / SOAP\nOptimizer Implementations]
    B --> C[Megatron Core Integration\nNVIDIA/Megatron-LM @ core_v0.18.0]
    C --> D[Tensor Parallel Support]
    C --> E[Split QKV Support]
    B --> F[Benchmarks Blog\ndeveloper.nvidia.com]
Loading

Reviews (1): Last reviewed commit: "update readme" | Re-trigger Greptile

Comment thread README.md
### Integration with Megatron Core

Integration with Megatron Core is available in **dev** branch, e.g. [emerging_optimizers.py](https://github.com/NVIDIA/Megatron-LM/blob/dev/megatron/core/optimizer/emerging_optimizers.py)
Emerging optimizer has been integrated into Megatron Core with tensor parallel support and many other features (split QKV for example), check out [emerging_optimizers.py](https://github.com/NVIDIA/Megatron-LM/blob/core_v0.18.0/megatron/core/optimizer/emerging_optimizers.py).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Minor subject–verb agreement: the project is consistently referred to as "Emerging Optimizers" (plural) throughout the README, but this sentence opens with the singular "Emerging optimizer".

Suggested change
Emerging optimizer has been integrated into Megatron Core with tensor parallel support and many other features (split QKV for example), check out [emerging_optimizers.py](https://github.com/NVIDIA/Megatron-LM/blob/core_v0.18.0/megatron/core/optimizer/emerging_optimizers.py).
Emerging optimizers have been integrated into Megatron Core with tensor parallel support and many other features (split QKV for example), check out [emerging_optimizers.py](https://github.com/NVIDIA/Megatron-LM/blob/core_v0.18.0/megatron/core/optimizer/emerging_optimizers.py).

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@skyw

skyw commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test 445a563

@github-actions

Copy link
Copy Markdown

Test Results

0 files   -    52  0 suites   - 122   0s ⏱️ - 1m 31s
0 tests  - 1 139  0 ✅  - 1 139  0 💤 ±0  0 ❌ ±0 
0 runs   - 2 529  0 ✅  - 2 529  0 💤 ±0  0 ❌ ±0 

Results for commit 445a563. ± Comparison against base commit 7ebd3cf.

@skyw skyw merged commit 84ddd02 into main Jun 23, 2026
20 checks passed
@skyw skyw deleted the skyw/update_readme branch June 23, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-only With great power comes great responsibility.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants