Skip to content

Conversation

@sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jun 18, 2025

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).

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • 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>
Copilot AI review requested due to automatic review settings June 18, 2025 10:04
@sven1977 sven1977 requested a review from a team as a code owner June 18, 2025 10:04
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Copy link
Contributor

Copilot AI left a 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"))
Copy link

Copilot AI Jun 18, 2025

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.

Copilot uses AI. Check for mistakes.
@sven1977 sven1977 enabled auto-merge (squash) June 18, 2025 11:44
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jun 18, 2025
@sven1977 sven1977 disabled auto-merge June 18, 2025 11:45
@ArturNiederfahrenhorst ArturNiederfahrenhorst merged commit 5c64312 into ray-project:master Jun 19, 2025
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>
@sven1977 sven1977 deleted the fix_vpg_shared_encoder_example branch June 28, 2025 08:25
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants