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

[Refactor] Rename Recorder and LogReward #2616

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

raresdan
Copy link
Contributor

@raresdan raresdan commented Nov 29, 2024

Description

Renamed the Recorder to LogValidationReward since it basically does just that.
Renamed LogReward to LogScalar and to make it more universal since it is actually just a class to log numeric values.

Motivation and Context

When dealing with logging, it was hard to grasp how to use different loggers and classes. Especially, the Recorder makes it difficult to grasp the idea behind it.

For the LogReward class, there was a need to make it more universal since it is actually just a class to log numeric values.

  • 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:

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

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 Nov 29, 2024

🔗 Helpful Links

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

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
Copy link

Hi @raresdan!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@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 Nov 29, 2024
@vmoens vmoens added the Refactoring Refactoring of an existing feature label Nov 29, 2024
@vmoens vmoens changed the title [Feature Request] Rename Recorder and LogReward [Refactor] Rename Recorder and LogReward Nov 29, 2024
Copy link
Contributor

@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, I'd just keep the imports in __init__.py, otherwise the change may be too abrupt

torchrl/trainers/__init__.py Show resolved Hide resolved
torchrl/trainers/__init__.py Show resolved Hide resolved
torchrl/trainers/trainers.py Outdated Show resolved Hide resolved
torchrl/trainers/trainers.py Outdated Show resolved Hide resolved
Copy link
Contributor

@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

@vmoens vmoens force-pushed the refactor-log-classes branch from ce45ccd to 568cef4 Compare December 2, 2024 17:47
@vmoens vmoens force-pushed the refactor-log-classes branch from 568cef4 to cb0d890 Compare December 3, 2024 14:35
@vmoens vmoens merged commit 607ebc5 into pytorch:main Dec 3, 2024
1 check passed
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. Refactoring Refactoring of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants