Skip to content
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] Fix Single/MultiAgentEnvRunner missing env-to-module connector call in _sample_episodes(). #45517

Merged

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented May 23, 2024

Fix Single/MultiAgentEnvRunner missing env-to-module connector call in _sample_episodes().

The env-to-module connector call on the terminal obs is missing in both Single- and MultiAgentEnvRunners _sample_episodes() methods. It is, however, properly implemented in both their _sample_timesteps() methods.

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 <[email protected]>
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Great catch!

3) Callback `on_episode_step` is fired.
4) Another env-to-module connector call is made (even though we won't need any
RLModule forward pass anymore). We make this additional call to ensure that in
case users use the connector pipeline to process observations (and write them
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, very important. Good catch!

shared_data=self._shared_data,
)
if self.module is not None:
self._env_to_module(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Episode is written in-place, correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, correct.
Some connectors act as preprocessors: read from episode, change the obs, write it right back in.

We should probably make this the default pattern for all connectors that preprocess observations. Right now we have some that do this, but others do NOT write back into the episode and therefore rely on two more connectors around them: AddObsFromEpisodeToBatch AND WriteObsToEpisode. This is causing a lot of confusion right now.

Signed-off-by: sven1977 <[email protected]>
@sven1977 sven1977 enabled auto-merge (squash) May 23, 2024 13:30
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label May 23, 2024
Signed-off-by: sven1977 <[email protected]>
@github-actions github-actions bot disabled auto-merge May 23, 2024 14:40
@sven1977 sven1977 merged commit 4ebbcbf into ray-project:master May 23, 2024
6 checks passed
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.

2 participants