Skip to content

docs: add missing async_grpo.enabled flag to configuration#1237

Merged
terrykong merged 1 commit intoNVIDIA-NeMo:mainfrom
youngeunkwon0405:async-doc-fix
Oct 3, 2025
Merged

docs: add missing async_grpo.enabled flag to configuration#1237
terrykong merged 1 commit intoNVIDIA-NeMo:mainfrom
youngeunkwon0405:async-doc-fix

Conversation

@youngeunkwon0405
Copy link
Copy Markdown
Contributor

@youngeunkwon0405 youngeunkwon0405 commented Sep 30, 2025

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

  • Documentation
    • Updated the Async GRPO guide to include clear instructions for enabling the feature via configuration.
    • Added examples demonstrating how to turn on Async GRPO in both relevant configuration sections.
    • Clarified enablement behavior and expectations without changing functionality.

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 30, 2025

📝 Walkthrough

Walkthrough

Adds an enabled flag for Async GRPO in two YAML configuration sections within the Async GRPO guide: policy.async_grpo.enabled: true and grpo.async_grpo.enabled: true. No other modifications.

Changes

Cohort / File(s) Summary
Docs: Async GRPO config flags
docs/guides/async-grpo.md
Documents two YAML options to enable Async GRPO: adds policy.async_grpo.enabled: true and grpo.async_grpo.enabled: true; no other content changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

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 The PR only updates documentation by adding two configuration flags in the async GRPO guide and does not change any code logic, introduce new features, or modify performance-critical behavior, so it is a minor change that does not require test results in the description.
Title Check ✅ Passed The title clearly summarizes the change to documentation by adding the missing async_grpo.enabled configuration flag. It reflects the docs context and precisely matches the content of the update without unnecessary detail or ambiguity. It is concise, specific, and provides clear insight into the primary change.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@youngeunkwon0405
Copy link
Copy Markdown
Contributor Author

youngeunkwon0405 commented Oct 1, 2025

Hi @parthchadha, I guess the enabled knob is missing from the doc.

@terrykong terrykong enabled auto-merge (squash) October 2, 2025 17:14
@terrykong terrykong disabled auto-merge October 2, 2025 17:14
@terrykong
Copy link
Copy Markdown
Collaborator

@CodeRabbit title

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 2, 2025

Tip

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

@terrykong, the current PR title "fix: fix async grpo doc" could be more descriptive. Here are some suggestions for a clearer title:

Recommended:

  • docs: add missing async_grpo.enabled flag to configuration
  • docs: add enabled flag to async GRPO configuration examples

Alternative:

  • fix(docs): add missing async_grpo.enabled configuration flag

These titles:

  1. Use docs: prefix since this is a documentation change (more accurate than fix:)
  2. Clearly indicate what was added/fixed
  3. Mention the specific configuration flag that was missing
  4. Follow conventional commit format

Would you like me to update the PR title to one of these suggestions?

@terrykong terrykong changed the title fix: fix async grpo doc docs: add missing async_grpo.enabled flag to configuration Oct 2, 2025
@terrykong terrykong enabled auto-merge (squash) October 2, 2025 17:15
@terrykong terrykong added CI:docs Run doctest and removed CI:docs Run doctest labels Oct 2, 2025
@terrykong terrykong merged commit f1bfeb6 into NVIDIA-NeMo:main Oct 3, 2025
100 checks passed
PrinsYin pushed a commit to PrinsYin/RL that referenced this pull request Nov 30, 2025
…Mo#1237)

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
aroshanghias-nvd pushed a commit to aroshanghias-nvd/nemo-rl that referenced this pull request Feb 6, 2026
@coderabbitai coderabbitai Bot mentioned this pull request Feb 17, 2026
yuanhangsu1986 pushed a commit to yuanhangsu1986/RL-Nemontron-Edge-Omni that referenced this pull request Feb 21, 2026
…Mo#1237)

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.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

asyncRL CI:docs Run doctest Documentation Improvements or additions to documentation r0.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants