Skip to content

Conversation

xingyaoww
Copy link

@xingyaoww xingyaoww commented May 14, 2025

What does this PR do?

This PR updates the logging documentation to match the current implementation. The old documentation referred to metrics like env/reward_mean, ppo/mean_scores, etc., but the actual metrics used in the current implementation are different, such as objective/scores, objective/rlhf_reward, etc.

I have updated the documentation to reflect the current metrics and added a reference to the PPO Trainer documentation for more detailed information.

Fixes #3437

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Logging docs appear to be out of date
2 participants