Skip to content

docs: Update README to include NVIDIA NeMo Framework link#1392

Merged
terrykong merged 1 commit intomainfrom
snowmanwwg-patch-2
Oct 20, 2025
Merged

docs: Update README to include NVIDIA NeMo Framework link#1392
terrykong merged 1 commit intomainfrom
snowmanwwg-patch-2

Conversation

@snowmanwwg
Copy link
Copy Markdown
Contributor

@snowmanwwg snowmanwwg commented Oct 20, 2025

Summary by CodeRabbit

  • Documentation
    • Updated README to clarify Nemo RL's association with the NVIDIA NeMo Framework as an open-source post-training library, including a direct link to the framework.

Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 20, 2025

📝 Walkthrough

Walkthrough

The README.md file's Overview section was updated to explicitly attribute Nemo RL as an open-source post-training library under the NVIDIA NeMo Framework, with an added external hyperlink to the framework. The semantic meaning remains unchanged.

Changes

Cohort / File(s) Change Summary
Documentation
README.md
Updated Overview sentence to attribute Nemo RL to the NVIDIA NeMo Framework with external link

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • NVIDIA-NeMo/RL#1091: Also modifies README's Overview/description of Nemo RL, restructuring and expanding the project description.

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 changes. Docstring coverage check skipped.
Test Results For Major Changes ✅ Passed Based on the provided pull request summary, this change is limited to updating README.md with an improved Overview description that attributes Nemo RL to the NVIDIA NeMo Framework and adds a hyperlink. The summary explicitly states "No changes to functionality or other content," confirming this is a documentation-only change. Since the custom check instructions specify to pass if "the changes are minor," and this PR contains only minor documentation updates with no impact on code functionality, numerics, convergence, or performance, the check criteria are satisfied.
Title Check ✅ Passed The pull request title "docs: Update README to include NVIDIA NeMo Framework link" directly and accurately reflects the main change described in the raw summary: updating the README.md Overview section to add an external link to the NVIDIA NeMo Framework. The title is concise, uses a clear "docs:" prefix indicating documentation changes, and is specific enough for a teammate to understand the primary purpose of the changeset without being vague or misleading. There is no disconnect between the stated title and the actual changes made.
✨ 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-2

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.

@terrykong
Copy link
Copy Markdown
Collaborator

@CodeRabbit title

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 20, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the PR details and diff to understand the changes
gh pr view 1392 --json title,body,files

# Get the actual diff for the README file
gh pr diff 1392

Length of output: 1577


@terrykong The current title "Update README to include NVIDIA NeMo Framework link" is good and accurately describes the main change.

However, if you want to be more comprehensive, since the change also clarifies the relationship (from "developed by NVIDIA" to "under the NVIDIA NeMo Framework"), you could consider:

Alternative suggestions:

  1. Update README to clarify Nemo RL's relationship with NVIDIA NeMo Framework (emphasizes the clarification aspect)
  2. Add NVIDIA NeMo Framework link to README Overview (more specific about location)

That said, the current title is concise and clear - the link addition is the primary change, so I think it works well as-is. Let me know if you'd like me to help update it to something else!

@terrykong terrykong changed the title Update README to include NVIDIA NeMo Framework link docs: Update README to include NVIDIA NeMo Framework link Oct 20, 2025
@terrykong terrykong enabled auto-merge (squash) October 20, 2025 05:10
@terrykong terrykong merged commit 9a22e2c into main Oct 20, 2025
40 of 44 checks passed
@terrykong terrykong deleted the snowmanwwg-patch-2 branch October 20, 2025 05:16
terrykong pushed a commit that referenced this pull request Nov 1, 2025
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
terrykong pushed a commit that referenced this pull request Nov 1, 2025
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
terrykong pushed a commit that referenced this pull request Nov 2, 2025
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
lbliii pushed a commit that referenced this pull request Nov 3, 2025
Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
PrinsYin pushed a commit to PrinsYin/RL that referenced this pull request Nov 30, 2025
…o#1392)

Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
yuanhangsu1986 pushed a commit to yuanhangsu1986/RL-Nemontron-Edge-Omni that referenced this pull request Feb 21, 2026
…o#1392)

Signed-off-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Signed-off-by: yuanhangs <yuanhangs@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