[doc] [1/N] Adding doc strings and doc pages for public methods in `single_controller` by hongpeng-guo · Pull Request #1396 · verl-project/verl

hongpeng-guo · 2025-05-04T23:58:34Z

Checklist Before Starting

Search for similar PR(s).

What does this PR do?

This PR adds doc string for the public methods inside single_controller module, so that these methods can be reused and referenced better.
A new doc page Single Controller Interface was also added under the API Reference section.

TODO:

This is the first of a series of PRs to improve and stabilize the docs and API. TODOs include:

verl/trainer docs
verl/utils docs
Generally refine doc string of the whole repo

Next PR to review is #1397

Checklist Before Submitting

Read the Contribute Guide.
Apply pre-commit checks.
Add [BREAKING] to the PR title if it breaks any API.
Update the documentation about your changes in the docs.
Add CI test(s) if neccessary.

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

docs/api/single_controller.rst

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

docs/api/single_controller.rst

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

eric-haibin-lin · 2025-05-18T06:17:14Z

docs/api/single_controller.rst

+.. automodule:: verl.single_controller.ray
+   :members: RayWorkerGroup, create_colocated_worker_cls
+
+.. autoclass:: verl.single_controller.ray.megatron.NVMegatronRayWorkerGroup


shall we remove the ones for megatron in case they will be removed in the future

Sure. I will remove it and refine the rst files. I was just testing a newly added doc_test pipeline, I let me mark this PR as draft for now. Will turn it on when the modifications are ready to review.

Good for another round of review.

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

…in `trainer` and `utils` (#1397) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? * This PR adds doc string for the public methods inside `trainer` and `utils` module, so that these methods can be reused and referenced better. * Two new doc page `PPO Trainer Interface` and `Utilities` were also provided under the API Reference section. * Renamed one function `verl.utils._default_compute_score` to `verl.utils.default_compute_score`, as it was an external function used by other modules, i.e., trainer and recipe; <img width="1093" alt="Screenshot 2025-05-26 at 9 20 31 PM" src="https://github.com/user-attachments/assets/e361e6bd-a33b-426b-85b4-9fe93ab1e398" /> ### TODO This is the second of a series of PRs to improve and stabilize the docs and API. Stacked on top of #1396 TODO includes adding more useful utility functions to the doc with improved doc strings. ### Additional Info. - **Issue Number**: Fixes issue # or discussion # if any. - **Training**: [Note which backend this PR will affect: FSDP, Megatron, both, or none] - **Inference**: [Note which backend this PR will affect: vLLM, SGLang, both, or none] ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [x] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu> Co-authored-by: H <linhaibin.eric@gmail.com>

…in `trainer` and `utils` (verl-project#1397) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? * This PR adds doc string for the public methods inside `trainer` and `utils` module, so that these methods can be reused and referenced better. * Two new doc page `PPO Trainer Interface` and `Utilities` were also provided under the API Reference section. * Renamed one function `verl.utils._default_compute_score` to `verl.utils.default_compute_score`, as it was an external function used by other modules, i.e., trainer and recipe; <img width="1093" alt="Screenshot 2025-05-26 at 9 20 31 PM" src="https://github.com/user-attachments/assets/e361e6bd-a33b-426b-85b4-9fe93ab1e398" /> ### TODO This is the second of a series of PRs to improve and stabilize the docs and API. Stacked on top of verl-project#1396 TODO includes adding more useful utility functions to the doc with improved doc strings. ### Additional Info. - **Issue Number**: Fixes issue # or discussion # if any. - **Training**: [Note which backend this PR will affect: FSDP, Megatron, both, or none] - **Inference**: [Note which backend this PR will affect: vLLM, SGLang, both, or none] ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [x] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu> Co-authored-by: H <linhaibin.eric@gmail.com>

…methods in `single_controller` (verl-project#1396) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? This PR adds doc string for the public methods inside `single_controller` module, so that these methods can be reused and referenced better. A new doc page `Single Controller Interface` was also added under the API Reference section. ![Screenshot 2025-05-04 at 4 58 23 PM](https://github.com/user-attachments/assets/3848b0d3-fbab-4023-915f-47620ed2676a) ### TODO: This is the first of a series of PRs to improve and stabilize the docs and API. TODOs include: * `verl/trainer` docs * `verl/utils` docs * Generally refine doc string of the whole repo Next PR to review is verl-project#1397 ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [ ] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

…in `trainer` and `utils` (verl-project#1397) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? * This PR adds doc string for the public methods inside `trainer` and `utils` module, so that these methods can be reused and referenced better. * Two new doc page `PPO Trainer Interface` and `Utilities` were also provided under the API Reference section. * Renamed one function `verl.utils._default_compute_score` to `verl.utils.default_compute_score`, as it was an external function used by other modules, i.e., trainer and recipe; <img width="1093" alt="Screenshot 2025-05-26 at 9 20 31 PM" src="https://github.com/user-attachments/assets/e361e6bd-a33b-426b-85b4-9fe93ab1e398" /> ### TODO This is the second of a series of PRs to improve and stabilize the docs and API. Stacked on top of verl-project#1396 TODO includes adding more useful utility functions to the doc with improved doc strings. ### Additional Info. - **Issue Number**: Fixes issue # or discussion # if any. - **Training**: [Note which backend this PR will affect: FSDP, Megatron, both, or none] - **Inference**: [Note which backend this PR will affect: vLLM, SGLang, both, or none] ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [x] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu> Co-authored-by: H <linhaibin.eric@gmail.com>

…methods in `single_controller` (verl-project#1396) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? This PR adds doc string for the public methods inside `single_controller` module, so that these methods can be reused and referenced better. A new doc page `Single Controller Interface` was also added under the API Reference section. ![Screenshot 2025-05-04 at 4 58 23 PM](https://github.com/user-attachments/assets/3848b0d3-fbab-4023-915f-47620ed2676a) ### TODO: This is the first of a series of PRs to improve and stabilize the docs and API. TODOs include: * `verl/trainer` docs * `verl/utils` docs * Generally refine doc string of the whole repo Next PR to review is verl-project#1397 ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [ ] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

…in `trainer` and `utils` (verl-project#1397) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? * This PR adds doc string for the public methods inside `trainer` and `utils` module, so that these methods can be reused and referenced better. * Two new doc page `PPO Trainer Interface` and `Utilities` were also provided under the API Reference section. * Renamed one function `verl.utils._default_compute_score` to `verl.utils.default_compute_score`, as it was an external function used by other modules, i.e., trainer and recipe; <img width="1093" alt="Screenshot 2025-05-26 at 9 20 31 PM" src="https://github.com/user-attachments/assets/e361e6bd-a33b-426b-85b4-9fe93ab1e398" /> ### TODO This is the second of a series of PRs to improve and stabilize the docs and API. Stacked on top of verl-project#1396 TODO includes adding more useful utility functions to the doc with improved doc strings. ### Additional Info. - **Issue Number**: Fixes issue # or discussion # if any. - **Training**: [Note which backend this PR will affect: FSDP, Megatron, both, or none] - **Inference**: [Note which backend this PR will affect: vLLM, SGLang, both, or none] ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [x] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu> Co-authored-by: H <linhaibin.eric@gmail.com>

…methods in `single_controller` (verl-project#1396) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? This PR adds doc string for the public methods inside `single_controller` module, so that these methods can be reused and referenced better. A new doc page `Single Controller Interface` was also added under the API Reference section. ![Screenshot 2025-05-04 at 4 58 23 PM](https://github.com/user-attachments/assets/3848b0d3-fbab-4023-915f-47620ed2676a) ### TODO: This is the first of a series of PRs to improve and stabilize the docs and API. TODOs include: * `verl/trainer` docs * `verl/utils` docs * Generally refine doc string of the whole repo Next PR to review is verl-project#1397 ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [ ] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

…in `trainer` and `utils` (verl-project#1397) ### Checklist Before Starting - [x] Search for similar PR(s). ### What does this PR do? * This PR adds doc string for the public methods inside `trainer` and `utils` module, so that these methods can be reused and referenced better. * Two new doc page `PPO Trainer Interface` and `Utilities` were also provided under the API Reference section. * Renamed one function `verl.utils._default_compute_score` to `verl.utils.default_compute_score`, as it was an external function used by other modules, i.e., trainer and recipe; <img width="1093" alt="Screenshot 2025-05-26 at 9 20 31 PM" src="https://github.com/user-attachments/assets/e361e6bd-a33b-426b-85b4-9fe93ab1e398" /> ### TODO This is the second of a series of PRs to improve and stabilize the docs and API. Stacked on top of verl-project#1396 TODO includes adding more useful utility functions to the doc with improved doc strings. ### Additional Info. - **Issue Number**: Fixes issue # or discussion # if any. - **Training**: [Note which backend this PR will affect: FSDP, Megatron, both, or none] - **Inference**: [Note which backend this PR will affect: vLLM, SGLang, both, or none] ### Checklist Before Submitting - [x] Read the [Contribute Guide](https://github.com/volcengine/verl?tab=readme-ov-file#contribution-guide). - [x] Apply [pre-commit checks](https://github.com/volcengine/verl?tab=readme-ov-file#code-linting-and-formatting). - [ ] Add `[BREAKING]` to the PR title if it breaks any API. - [x] Update the documentation about your changes in the [docs](https://github.com/volcengine/verl/tree/main/docs). - [x] Add CI test(s) if neccessary. --------- Signed-off-by: Hongpeng Guo <hg5@illinois.edu> Co-authored-by: H <linhaibin.eric@gmail.com>

hongpeng-guo added 3 commits May 4, 2025 16:49

adding doc string and docs for single controller

5e7f5e7

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

add doc string for public methods for single controller

968c800

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

fix lint

2413c80

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

hongpeng-guo requested review from eric-haibin-lin and vermouth1992 May 4, 2025 23:59

hongpeng-guo changed the title ~~[doc] Adding doc strings and doc pages for public methods in single_controller~~ [doc] [1/N] Adding doc strings and doc pages for public methods in single_controller May 5, 2025

hongpeng-guo mentioned this pull request May 5, 2025

[doc][2/N] Adding doc strings and doc pages for public methods in trainer and utils #1397

Merged

6 tasks

eric-haibin-lin reviewed May 5, 2025

View reviewed changes

docs/api/single_controller.rst Show resolved Hide resolved

handle comments

752a5be

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

hongpeng-guo self-assigned this May 5, 2025

eric-haibin-lin reviewed May 5, 2025

View reviewed changes

docs/api/single_controller.rst Outdated Show resolved Hide resolved

eric-haibin-lin reviewed May 5, 2025

View reviewed changes

docs/api/single_controller.rst Show resolved Hide resolved

ZihengJiang assigned eric-haibin-lin May 7, 2025

ZihengJiang added the status: review in process label May 7, 2025

hongpeng-guo added 8 commits May 17, 2025 21:30

merge with main

7aa7b01

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update doc

a05690c

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

fix some docs errors

c5f616f

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

add doc test pipeline

da4837a

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update pipeline

1b9cf91

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update pipeline

0de7ee2

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update pipeline

042ef6f

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update pipeline

f10305c

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

eric-haibin-lin reviewed May 18, 2025

View reviewed changes

hongpeng-guo added 3 commits May 17, 2025 23:36

update pipeline

d9cc14e

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

update pipeline

17dabae

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

remove the deply module

8752526

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

hongpeng-guo marked this pull request as draft May 18, 2025 07:07

hongpeng-guo added 3 commits May 18, 2025 18:05

remove redundant apis of single controller

e04f4ee

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

Merge branch 'main' into hpguo/doc

4f878e3

fix merge errror

110c8f2

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

hongpeng-guo added 2 commits May 18, 2025 23:06

fix some doc strings

632189b

Signed-off-by: Hongpeng Guo <hg5@illinois.edu>

Merge remote-tracking branch 'origin' into hpguo/doc

66ceeec

hongpeng-guo marked this pull request as ready for review May 19, 2025 06:22

eric-haibin-lin approved these changes May 19, 2025

View reviewed changes

eric-haibin-lin merged commit 8788e55 into verl-project:main May 19, 2025
33 of 34 checks passed

hongpeng-guo deleted the hpguo/doc branch October 2, 2025 04:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] [1/N] Adding doc strings and doc pages for public methods in `single_controller`#1396

[doc] [1/N] Adding doc strings and doc pages for public methods in `single_controller`#1396
eric-haibin-lin merged 20 commits intoverl-project:mainfrom
hongpeng-guo:hpguo/doc

hongpeng-guo commented May 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eric-haibin-lin May 18, 2025

Uh oh!

hongpeng-guo May 18, 2025 •

edited

Loading

Uh oh!

hongpeng-guo May 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hongpeng-guo commented May 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist Before Starting

What does this PR do?

TODO:

Checklist Before Submitting

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eric-haibin-lin May 18, 2025

Choose a reason for hiding this comment

Uh oh!

hongpeng-guo May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hongpeng-guo May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hongpeng-guo commented May 4, 2025 •

edited

Loading

hongpeng-guo May 18, 2025 •

edited

Loading