Skip to content

[Doc] Add a visual explanation of the configuration to the documentation #1709

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.

Sign up for GitHub

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

Merged
hiyouga merged 1 commit into from
May 26, 2025
Merged

[Doc] Add a visual explanation of the configuration to the documentation #1709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/examples/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,13 @@ Trainer
for the ray register center to be ready. Default is 300 seconds.


This figure illustrates how the configurations affect the training.

https://excalidraw.com/#json=pfhkRmiLm1jnnRli9VFhb,Ut4E8peALlgAUpr7E5pPCA

.. image:: https://github.com/user-attachments/assets/16aebad1-0da6-4eb3-806d-54a74e712c2d


evaluation.yaml
---------------

Expand Down
6 changes: 4 additions & 2 deletions docs/faq/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ https://verl.readthedocs.io/en/latest/examples/config.html to disable just-in-ti
What is the meaning of train batch size, mini batch size, and micro batch size?
------------------------------------------------------------------------------------------

Please check out the following figure from the community (credit to @hiyouga)
This figure illustrates the relationship between different batch size configurations.

.. image:: https://github.com/hiyouga/EasyR1/blob/main/assets/easyr1_grpo.png
https://excalidraw.com/#json=pfhkRmiLm1jnnRli9VFhb,Ut4E8peALlgAUpr7E5pPCA

.. image:: https://github.com/user-attachments/assets/16aebad1-0da6-4eb3-806d-54a74e712c2d