-
Notifications
You must be signed in to change notification settings - Fork 271
doc: update docs for grpo and related algorithms #794
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
Conversation
Summary of ChangesHello @garrett4wade, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly refactors the documentation for reinforcement learning algorithms within the AReaL framework. It consolidates multiple individual algorithm pages into a single, comprehensive guide for PPO, GRPO, and their variants. This change aims to provide a more cohesive and easily navigable resource for users to understand the core concepts, configuration parameters, and interrelationships between these algorithms, improving the overall clarity and maintainability of the project's documentation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request significantly improves the documentation by consolidating information about GRPO and related algorithms into a single, comprehensive page. This makes it much easier for users to understand and compare these different PPO-style algorithms. The changes also include minor clarifications in the asynchronous RL documentation and dependency updates. My review focuses on ensuring the new documentation is clear and consistent. I've pointed out a minor LaTeX rendering issue in the mathematical formulas and a discrepancy between the documented PPO configuration and the example file.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
ZiyiTsang
left a 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.
The charpter order may need to be adjusted
I suggest placing the cli example at the beginning and the explanation at the end
ZiyiTsang
left a 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.
LGTM
Description
This PR creates a unified documentation page to address the concerns listed in #784
Related Issue
Fixes #784
Type of Change
work as expected)
Checklist
jb build docs/gemini review)