Skip to content

Conversation

@euronymous-aithal
Copy link
Contributor

@euronymous-aithal euronymous-aithal commented Jan 31, 2026

reflect 0.5 changes

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 README with Release v0.5.0 announcement including Docker container availability.
    • Added new features including On-Policy Distillation, Speculative Decoding, and Muon Optimizer support.
    • Expanded model and algorithm support coverage.
    • Refreshed Table of Contents and quick-start references.

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

reflect 0.5 changes 

Signed-off-by: Ashwath Aithal <[email protected]>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 31, 2026

📝 Walkthrough

Walkthrough

This PR updates the README.md documentation to reflect version 0.5.0 release information, reorganizes the features section with entries for new capabilities (Muon Optimizer, SGLang Inference, On-Policy Distillation, Speculative Decoding), and restores a Previous News block with dated updates from December 2025.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Added Release v0.5.0 news entry with Docker container and NeMo-Gym + NeMo-RL support; reinstated Previous News block with 12/1/2025 entries; reorganized Features section to include Muon Optimizer, SGLang Inference, On-Policy Distillation, and Speculative Decoding; updated Table of Contents and quick-start cross-references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

documentation, CI:docs, r0.5.0

Suggested reviewers

  • terrykong
  • snowmanwwg
🚥 Pre-merge checks | ✅ 4
✅ 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 This PR contains only minor documentation updates to README.md with no functional code changes that could affect numerics, convergence, or performance.
Title check ✅ Passed The title 'docs: update readme post 0.5' accurately reflects the main change—updating documentation for the v0.5.0 release with new features, news, and organizational improvements.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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
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

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 79-86: Update the README feature list to correct two user-facing
typos: change "suport" to "support" in the "SGLang Inference" bullet and change
"Speculaive Decoding" to "Speculative Decoding" in the corresponding bullet;
locate those exact strings ("SGLang Inference" and "Speculaive Decoding") in the
README content and replace the misspellings while preserving the existing
phrasing and punctuation.
- Line 85: The README line containing "🔜 **On-Policy Distillation** -
Multi-teacher and cross tokenizer distillation support" should hyphenate the
compound adjective: update the phrase to "Multi-teacher and cross-tokenizer
distillation support" (edit the README heading/text where that exact string
appears) so “cross-tokenizer” is grammatically correct.
- Around line 14-16: The nested list under the "0.5.0" news item has 4-space
indentation causing MD007 failures; update the nested bullet lines (eg. the
"NeMo-Gym + NeMo-RL support" and "📊 [Coming soon] release run" items) to use
2-space indentation so they align as a proper sub-list of the "Both
linux/amd64..." bullet.

@terrykong terrykong changed the title Update README.md docs: update readme post 0.5 Feb 1, 2026
@terrykong terrykong added the CI:docs Run doctest label Feb 1, 2026
@terrykong terrykong enabled auto-merge (squash) February 1, 2026 05:03
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.

3 participants