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] Add on_episode_created callback to SingleAgentEnvRunner. #49487

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 29, 2024

Add on_episode_created callback to SingleAgentEnvRunner.

With gymnasium=1.x in place, making this callback is now supported (b/c of the extra step required to get from terminal state to reset state).

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 :(

@sven1977 sven1977 added rllib RLlib related issues rllib-env rllib env related issues rllib-newstack labels Dec 29, 2024
@sven1977 sven1977 enabled auto-merge (squash) December 29, 2024 10:39
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 29, 2024
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. Important change. Multiple users already requested this feature again.

@@ -393,6 +393,11 @@ def _sample(
observation_space=self.env.single_observation_space,
action_space=self.env.single_action_space,
)
self._make_on_episode_callback(
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice, so this works again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, b/c the new gym 1.x does NOT automatically reset a done vector subenv anymore, but requires you to take the extra step from terminal observation to reset observation "manually". This allows us to slip in the callback again.

Signed-off-by: sven1977 <svenmika1977@gmail.com>
…on_episode_created_to_single_agent_env_runner
@github-actions github-actions bot disabled auto-merge December 30, 2024 12:12
@sven1977 sven1977 enabled auto-merge (squash) December 30, 2024 12:12
@sven1977 sven1977 merged commit 122cff8 into ray-project:master Dec 30, 2024
6 checks passed
@sven1977 sven1977 deleted the add_on_episode_created_to_single_agent_env_runner branch December 30, 2024 17:03
anyadontfly pushed a commit to anyadontfly/ray that referenced this pull request Feb 13, 2025
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 rllib RLlib related issues rllib-env rllib env related issues rllib-newstack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants