-
Notifications
You must be signed in to change notification settings - Fork 7k
[RLlib; docs] Fix docstring example for custom MultiRLModule with shared encoder. #53912
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
[RLlib; docs] Fix docstring example for custom MultiRLModule with shared encoder. #53912
Conversation
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.
Pull Request Overview
This PR fixes the docstring example for a custom MultiRLModule with a shared encoder by ensuring that a required action_space is defined and the correct module is referenced in the example.
- Added action_space to the shared encoder module specification.
- Updated the module retrieval call to explicitly reference the "p0" module.
- Modified algorithm configuration to fallback to policy_spec for missing observation or action spaces.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| rllib/examples/rl_modules/classes/vpg_using_shared_encoder_rlm.py | Added action_space to shared encoder's spec and updated a module retrieval call to get_module("p0"). |
| rllib/algorithms/algorithm_config.py | Revised fallback logic to set missing observation_space or action_space from policy_spec. |
Comments suppressed due to low confidence (1)
rllib/algorithms/algorithm_config.py:4641
- [nitpick] Consider adding an inline comment explaining the fallback logic for setting module_spec observation_space and action_space from policy_spec, to aid future maintainers.
):
| algo = config.build() | ||
| print(algo.get_module()) | ||
| # __sphinx_doc_how_to_run_end__ | ||
| print(algo.get_module("p0")) |
Copilot
AI
Jun 18, 2025
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.
Using an explicit module identifier 'p0' clarifies which module to print. Please ensure that 'p0' is consistently defined in your module specifications.
5c64312
into
ray-project:master
…red encoder. (ray-project#53912) <!-- Thank you for your contribution! Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request. --> Fix docstring example for custom MultiRLModule with shared encoder. * Needed action_space definition on shared encoder module. * do not require action_space to be defined in `RLModuleSpec` when `build` is called. The spec may be for a component that doesn't care about that space (like a shared encoder or a value function). <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes ray-project#1234" --> ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: sven1977 <svenmika1977@gmail.com>
…red encoder. (#53912) <!-- Thank you for your contribution! Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request. --> Fix docstring example for custom MultiRLModule with shared encoder. * Needed action_space definition on shared encoder module. * do not require action_space to be defined in `RLModuleSpec` when `build` is called. The spec may be for a component that doesn't care about that space (like a shared encoder or a value function). <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes #1234" --> ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [ ] I've included any doc changes needed for https://docs.ray.io/en/master/. - [ ] I've added any new APIs to the API Reference. For example, if I added a method in Tune, I've added it in `doc/source/tune/api/` under the corresponding `.rst` file. - [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [ ] Unit tests - [ ] Release tests - [ ] This PR is not tested :( --------- Signed-off-by: sven1977 <svenmika1977@gmail.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Fix docstring example for custom MultiRLModule with shared encoder.
RLModuleSpecwhenbuildis called. The spec may be for a component that doesn't care about that space (like a shared encoder or a value function).Why are these changes needed?
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.