-
Notifications
You must be signed in to change notification settings - Fork 233
docs: update readme post 0.5 #1856
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
reflect 0.5 changes Signed-off-by: Ashwath Aithal <[email protected]>
📝 WalkthroughWalkthroughThis 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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.
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
# Add a code snippet demonstrating how to use thisBefore your PR is "Ready for review"
Pre checks:
Additional Information
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.