[Feature Request] Rename Recorder and LogReward
Open
@vmoens is already working on this.
Since Nov 26, 2024.
enhancement
- Dominant language
- Python
- Stars
- 3.6k
- Forks
- 487
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 207
Description
Motivation
-
When dealing with logging, I found it 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, I would love to make it more universal since it is actually just a class to log numeric values isn't it?
Solution
- rename the Recorder to LogValidationReward since it basically does just that.
- rename LogReward to LogScalar and give examples in the docs how to log the reward.
Alternatives
- Include a validation step in the trainer with additional hooks that allow for validation based actions (just log validation metrics).
- Add a LogScalar class from which LogReward inherits
Checklist
- I have checked that there is no similar issue in the repo (required)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.