Skip to content

[RLlib] Episode API: Add custom_data property and deprecate add|get_temporary_timestep_data() APIs. #52603

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[RLlib] Episode API: Add custom_data property and deprecate add|get_temporary_timestep_data() APIs. #52603

wants to merge 4 commits into from

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Apr 25, 2025 •
edited
Loading

Episode API: Add custom_data property and deprecate add|get_temporary_timestep_data() APIs.

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
wip
1f7574c 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 marked this pull request as ready for review April 25, 2025 09:22
@sven1977 sven1977 requested a review from simonsays1980 as a code owner April 25, 2025 09:22
@sven1977 sven1977 added rllib RLlib related issues rllib-env rllib env related issues rllib-envrunners Issues around the sampling backend of RLlib labels Apr 25, 2025
@sven1977
LINT
fdd0c01 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) April 25, 2025 10:36
@github-actions github-actions bot disabled auto-merge April 25, 2025 10:36
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Apr 25, 2025
@sven1977
docs
b13db13 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 requested review from maxpumperla and a team as code owners April 25, 2025 10:59
simonsays1980
simonsays1980 approved these changes Apr 25, 2025
View reviewed changes
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. This is convenient for users and for us: we do not have to manage access or check at whcih points to cut or merge.

rllib/env/multi_agent_episode.py
self._temporary_timestep_data = defaultdict(list)
# Cache for custom data. May be used to store custom metrics from within a
# callback for the ongoing episode (e.g. render images).
self.custom_data = {}
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should set this private and give it a setter such that users can manipulate what is IN it but not the attribute itself.

@sven1977
fix
d4c7e8b 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) April 26, 2025 06:55
@github-actions github-actions bot disabled auto-merge April 26, 2025 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonsays1980 simonsays1980 simonsays1980 approved these changes

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

Assignees

@simonsays1980 simonsays1980

Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-env rllib env related issues rllib-envrunners Issues around the sampling backend of RLlib
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sven1977 @simonsays1980