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.

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

[RLlib] Cleanup examples folder vol. 24: Add example script for how to log custom metrics in training_step(). #49976

Merged
merged 15 commits into from
Jan 21, 2025
Merged

[RLlib] Cleanup examples folder vol. 24: Add example script for how to log custom metrics in training_step(). #49976

merged 15 commits into from
Jan 21, 2025

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jan 20, 2025 •
edited
Loading

Cleanup examples folder vol. 24: Add example script for how to log custom metrics in training_step().

  • Shows how to override existing VPG algo and its training_step method to add one more log_value() call.
  • Adds example script to CI and docs.
  • Asserts that custom metrics is indeed logged in the result dict.

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
77a30a1 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into clea…
37f146c 
…nup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into clea…
1fcf7bd 
…nup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step
@sven1977
wip
87cc703 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into clea…
fedc9c7 
…nup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step
@sven1977 sven1977 added rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack labels Jan 20, 2025
simonsays1980
simonsays1980 approved these changes Jan 21, 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.

@sven1977
wip
f078ff6 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into clea…
c9f8090 
…nup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step
@sven1977
fixes
eeaa405 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) January 21, 2025 11:40
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jan 21, 2025
@sven1977
fixes
b591e00 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 21, 2025 11:53
@sven1977
fixes
ddd4910 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fixes
e107119 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into clea…
de09c7f 
…nup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step
@sven1977
wip
60cf62e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) January 21, 2025 13:28
@github-actions github-actions bot disabled auto-merge January 21, 2025 13:28
@sven1977
wip
4876987 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
fbfbcc8 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) January 21, 2025 15:06
@sven1977 sven1977 merged commit 2cd22aa into ray-project:master Jan 21, 2025
6 checks passed
@sven1977 sven1977 deleted the cleanup_examples_folder_24_custom_metrics_and_callbacks_algo_training_step branch January 21, 2025 18:03
win5923 pushed a commit to win5923/ray that referenced this pull request Jan 23, 2025
@sven1977 @win5923
[RLlib] Cleanup examples folder vol. 24: Add example script for how t…
b2f97f0 
…o log custom metrics in `training_step()`. (ray-project#49976)
simonsays1980 pushed a commit to simonsays1980/ray that referenced this pull request Jan 23, 2025
@sven1977 @simonsays1980
[RLlib] Cleanup examples folder vol. 24: Add example script for how t…
70f9463 
…o log custom metrics in `training_step()`. (ray-project#49976)
anson627 pushed a commit to anson627/ray that referenced this pull request Jan 31, 2025
@sven1977 @anson627
[RLlib] Cleanup examples folder vol. 24: Add example script for how t…
1ae2296 
…o log custom metrics in `training_step()`. (ray-project#49976)

Signed-off-by: Anson Qian <anson627@gmail.com>
srinathk10 pushed a commit that referenced this pull request Feb 2, 2025
@sven1977 @srinathk10
[RLlib] Cleanup examples folder vol. 24: Add example script for how t…
05e229b 
…o log custom metrics in `training_step()`. (#49976)
anyadontfly pushed a commit to anyadontfly/ray that referenced this pull request Feb 13, 2025
@sven1977 @anyadontfly
[RLlib] Cleanup examples folder vol. 24: Add example script for how t…
41bd1e6 
…o log custom metrics in `training_step()`. (ray-project#49976)

Signed-off-by: Puyuan Yao <williamyao034@gmail.com>
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-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack
Projects
None yet
Milestone
No milestone
Development

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