Skip to content

Conversation

NTR0314
Copy link
Contributor

@NTR0314 NTR0314 commented Jun 17, 2025

Description

Adds an optional log_explained_variance flag to PPOLoss (and subclasses) so users can log the critic’s explained‑variance metric during training.

Motivation and Context

The metric helps monitor critic fit and matches sklearn.metrics.explained_variance_score. Also used by other libraries such as stable baselines.

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Remove all that do not apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality) <- idk if it is core functionality though.
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of examples)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • [] I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.

Copy link

pytorch-bot bot commented Jun 17, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/3010

Note: Links to docs will display an error until the docs builds have been completed.

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 17, 2025
@vmoens vmoens changed the title Add optional Explained Variance logging [Feature] Add optional Explained Variance logging Jun 20, 2025
@vmoens vmoens added the enhancement New feature or request label Jun 20, 2025
Copy link
Collaborator

@vmoens vmoens left a comment

Choose a reason for hiding this comment

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

LGTM thanks for this!

Defaults to True since there is marginal overhead.
@vmoens vmoens force-pushed the feat/ppo-explained-var branch from 6835599 to f579553 Compare June 20, 2025 14:12
@vmoens vmoens merged commit e1e15d6 into pytorch:main Jun 20, 2025
1 check passed
@vmoens vmoens linked an issue Jul 11, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Explained Variance
3 participants