docs: Create performance-summary.md for NeMo RL

[snowmanwwg]

Added performance summary documentation for NeMo RL, including benchmarks, nomenclature, and performance metrics for large language models.

Summary by CodeRabbit

• Documentation
  • Added comprehensive performance benchmarks documentation for NeMo RL framework, detailing performance metrics, training configurations, and generation performance across different systems and models.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

A new documentation file is added to provide benchmarking information for NVIDIA NeMo Framework's NeMo RL training. The document includes performance metrics nomenclature, summary structure, and placeholder tables with TODO items for future updates.

Changes

Cohort / File(s)	Summary
Performance documentation docs/performance-summary.md	New file added documenting NeMo RL performance benchmarks, including metrics definitions (Step time, Tokens/sec/GPU, Training MFU), scaffold structure for performance data tables, and placeholder entries for GRPO Performance benchmarks

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Review is straightforward since this is a documentation-only addition with placeholder content and TODO markers

Suggested labels

CI:docs

Suggested reviewers

• terrykong

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 adds documentation file with performance benchmarks; documentation-only changes without code modifications are minor and do not require formal test documentation per custom check criteria.
Title check	✅ Passed	The title 'docs: Create performance-summary.md for NeMo RL' directly and clearly describes the main change—adding a new documentation file for NeMo RL performance benchmarks.

✨ 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 snowmanwwg-patch-4

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

📜 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 4a59436 and 76b258b.

📒 Files selected for processing (1)

• docs/performance-summary.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-20T14:59:08.052Z

Learnt from: CR
Repo: NVIDIA-NeMo/RL PR: 0
File: coderabbit-custom-pre-merge-checks-unique-id-file-non-traceable-F7F2B60C-1728-4C9A-8889-4F2235E186CA.txt:0-0
Timestamp: 2025-09-20T14:59:08.052Z
Learning: If a change could affect performance, include before-and-after performance numbers in the PR description, along with configuration and context.

Applied to files:

• docs/performance-summary.md

⏰ 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). (4)

• 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

🔇 Additional comments (2)

docs/performance-summary.md (2)

1-60: Add performance context to the PR description.

Per learnings, when a change involves performance documentation or impacts performance, the PR description should include before-and-after performance numbers, along with configuration and context. This helps reviewers understand the significance of the changes and any performance implications.

Please update the PR description to include relevant performance context or benchmarking goals for this documentation.

---

54-57: The table structure is correctly aligned and will render properly.

Verification shows all four rows (header, separator, and both data rows) contain exactly 19 pipes, which means 18 columns across the entire table. While the spacing around pipes is inconsistent for visual readability, the underlying table structure is sound and will parse correctly in Markdown. No fixes are required.

Likely an incorrect or invalid review comment.

[terrykong]

@snowmanwwg did you want to put this in the sidebar of our docs?

If so, you'll need to add this document into docs/index.md

[snowmanwwg]

@snowmanwwg did you want to put this in the sidebar of our docs?

If so, you'll need to add this document into `docs/index.md`

Yes I want it to be an item in the side bar. How to add to index.md?

[ZhiyuLi-Nvidia]

Added the formula for tokens/sec/GPU

[ZhiyuLi-Nvidia]

Can we also replace MOE with MoE? I felt like the latter is more common.