docs: document reward logging contract - #1571
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
reward/<term>is the UniLab per-term diagnostic,Train/mean_rewardis the native RSL-RL aggregate return metric, andEpisode_Termination/<term>is a distinct termination diagnostic.Episode_Reward/<term>is intentionally removed and may still appear in historical TensorBoard event files.Linked Work
mainValidation
make test-allpassed on the final local head before this PR was created or updatedmake test-allwas not run because this is a docs-only change; the repository's docs-specific gate fromdocs/sphinx/AGENTS.mdwas used instead.Commands actually run:
Results:
19 passed in 0.36sRemote CI route:
main: current-head CI is the remote gate for this PR.Impact
Artifacts
Checklist