[RLlib; docs] Fix docstring example for custom MultiRLModule with shared encoder.#53912
Merged
ArturNiederfahrenhorst merged 2 commits intoray-project:masterfrom Jun 19, 2025
Conversation
Contributor
There was a problem hiding this comment.
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")) |
There was a problem hiding this comment.
Using an explicit module identifier 'p0' clarifies which module to print. Please ensure that 'p0' is consistently defined in your module specifications.
ArturNiederfahrenhorst
approved these changes
Jun 19, 2025
5c64312
into
ray-project:master
6 of 7 checks passed
minerharry
pushed a commit
to minerharry/ray
that referenced
this pull request
Jun 27, 2025
…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>
elliot-barn
pushed a commit
that referenced
this pull request
Jul 2, 2025
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.