Skip to content

docs: update roadmap post v0.4#1607

Merged
terrykong merged 4 commits intomainfrom
euronymous-aithal-patch-1
Dec 7, 2025
Merged

docs: update roadmap post v0.4#1607
terrykong merged 4 commits intomainfrom
euronymous-aithal-patch-1

Conversation

@euronymous-aithal
Copy link
Copy Markdown
Contributor

@euronymous-aithal euronymous-aithal commented Dec 6, 2025

updated to Features

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

Issues

List issues that this PR closes (syntax):

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
  • Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

  • ...

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated supported models documentation: added gpt-oss, Qwen3-Next, and Nemotron-Nano3
    • Enhanced feature documentation for integrations including Nemo-Gym and Megatron Inference
    • Clarified advanced capabilities such as LoRA support, fault tolerance, auto-scaling, and low-precision training

✏️ Tip: You can customize this high-level summary in your review settings.

updated to Features 

Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 6, 2025

📝 Walkthrough

Walkthrough

This PR updates the README.md file's Features section by replacing upcoming-feature entries with expanded, refined items including new models (gpt-oss, Qwen3-Next, Nemotron-Nano3), additional algorithms (LoRA support, fault tolerance), and clarified integration paths (NeMo Automodel, NeMo Megatron Bridge).

Changes

Cohort / File(s) Change Summary
README Documentation Updates
README.md
Replaced and expanded multiple feature entries in the Features section: added new models and algorithms, clarified integration paths and middleware references (NeMo Automodel, Megatron Bridge), updated Hugging Face Integration description, and reinstated/clarified End-to-End FP8 and Vision Language Models entries.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

  • Areas to review:
    • Verify accuracy of new model names and their current availability status
    • Confirm that all referenced integration paths (NeMo Automodel, NeMo Megatron Bridge, DTensor) align with actual implementation or roadmap
    • Check for consistency in terminology and formatting across all feature entries
    • Ensure new entries do not conflict with or duplicate other existing feature descriptions

Possibly related PRs

Suggested labels

documentation, CI:docs

Suggested reviewers

  • terrykong
  • chtruong814
  • snowmanwwg

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Results For Major Changes ✅ Passed PR contains only documentation changes to README.md updating feature descriptions and integration paths, which are inherently minor changes not requiring test results per custom check criteria.
Title check ✅ Passed The title 'docs: update roadmap post v0.4' clearly and specifically describes the main change—updating documentation/roadmap after version 0.4 release, which aligns with the summary showing README.md roadmap feature updates.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch euronymous-aithal-patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
README.md (1)

75-96: Consider rewording repeated sentence structures in the Features list (optional refinement).

Static analysis flagged that lines 77–80 have successive bullet items beginning with "Improve" or similar phrases, which creates repetitive phrasing:

  • Line 77: "Improved Native Performance – Improve..."
  • Line 78: "Improved Large MoE Performance – Improve..."
  • Line 79: "New Models – ..."
  • Line 80: "Expand Algorithms – ..."

While acceptable in a bullet list, you may consider varying the phrasing for better readability. For example:

- 🔜 **Improved Native Performance** - Improve training time for native PyTorch models.
- 🔜 **Improved Large MoE Performance** - Improve Megatron Core training performance and generation performance.
+ 🔜 **Improved Native Performance** - Optimize training time for native PyTorch models.
+ 🔜 **Improved Large MoE Performance** - Accelerate Megatron Core training and generation performance.

This is an optional style refinement and not a blocking issue.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0947683 and 549a60b.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
!(**/tests/**|**/test_*.py|**/test_*.sh)

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Add the NVIDIA copyright header to all Python files and shell scripts (excluding tests). The header should include the current year

Files:

  • README.md
🪛 LanguageTool
README.md

[style] ~77-~77: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... Inference (avoid weight conversion). - 🔜 Improved Native Performance - Impro...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~78-~78: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ining time for native PyTorch models. - 🔜 Improved Large MoE Performance - Im...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~79-~79: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...rformance and generation performance. - 🔜 New Models - gpt-oss, Qwen3-Next, N...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... gpt-oss, Qwen3-Next, Nemotron-Nano3. - 🔜 Expand Algorithms - LoRA support fo...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[grammar] ~81-~81: Use a hyphen to join words.
Context: ...Resiliency* - Fault tolernace and auto scaling support - 🔜 GB200 - Add con...

(QB_NEW_EN_HYPHEN)


[grammar] ~88-~88: Ensure spelling is correct
Context: ...SP for efficient training (through NeMo Automdeol). - ✅ **Larger Model Support with Longe...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~92-~92: Ensure spelling is correct
Context: ... - OOB support in the DTenor path, CKPT coversion available for Megatron path through Meg...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: sphinx-build / Build docs
  • GitHub Check: build-container / main
  • GitHub Check: Lint check
  • GitHub Check: Post submodule check comment / Comment on PR
  • GitHub Check: Post automodel integration comment / Comment on PR

terrykong
terrykong previously approved these changes Dec 7, 2025
@terrykong terrykong changed the title Update README.md docs: update roadmap post v0.4 Dec 7, 2025
@terrykong terrykong added the CI:docs Run doctest label Dec 7, 2025
@terrykong terrykong enabled auto-merge (squash) December 7, 2025 18:46
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Terry Kong <terrycurtiskong@gmail.com>
terrykong and others added 2 commits December 7, 2025 10:47
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Terry Kong <terrycurtiskong@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Terry Kong <terrycurtiskong@gmail.com>
@terrykong terrykong added CI:docs Run doctest and removed CI:docs Run doctest labels Dec 7, 2025
@terrykong terrykong merged commit 64ab08d into main Dec 7, 2025
28 checks passed
@terrykong terrykong deleted the euronymous-aithal-patch-1 branch December 7, 2025 18:57
DeL-TaiseiOzaki pushed a commit to DeL-TaiseiOzaki/RL that referenced this pull request Jan 8, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
This was referenced Jan 31, 2026
yuanhangsu1986 pushed a commit to yuanhangsu1986/RL-Nemontron-Edge-Omni that referenced this pull request Feb 12, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Signed-off-by: yuanhangs <yuanhangs@nvidia.com>
yuanhangsu1986 pushed a commit to yuanhangsu1986/RL-Nemontron-Edge-Omni that referenced this pull request Feb 21, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Signed-off-by: yuanhangs <yuanhangs@nvidia.com>
seonjinn pushed a commit that referenced this pull request Mar 8, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
seonjinn pushed a commit that referenced this pull request Mar 8, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
seonjinn pushed a commit that referenced this pull request Mar 9, 2026
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI:docs Run doctest

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants