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] Make Tune trial ID available in EnvRunners (and callbacks). #46294

Merged

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jun 27, 2024

Make Tune trial ID available in EnvRunners (and callbacks).

  • EnvRunners get a self.tune_trial_id property.
  • This property is available in all env-runner based callbacks via the env_runner arg (access env_runner.tune_trial_id inside your callbacks).

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>
@sven1977 sven1977 enabled auto-merge (squash) June 27, 2024 12:15
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jun 27, 2024
@github-actions github-actions bot disabled auto-merge June 27, 2024 12:51
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.

@@ -63,7 +63,8 @@ def __init__(self, config: AlgorithmConfig, **kwargs):
"""
super().__init__(config=config)

self.worker_index = kwargs.get("worker_index")
self.worker_index: int = kwargs.get("worker_index")
self.tune_trial_id: str = kwargs.get("tune_trial_id")
Copy link
Collaborator

Choose a reason for hiding this comment

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

For what do we need the trial ID in the env runners? For callbacks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Some users might need this in their env.

@sven1977 sven1977 merged commit 5323e73 into ray-project:master Jun 27, 2024
6 checks passed
@sven1977 sven1977 deleted the make_trial_id_available_in_env_runners branch June 27, 2024 14:35
@grizzlybearg
Copy link

Thanks for this. This will be very useful in keeping track of details of episodes within trials

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