Update LearningRateMonitor
docs and tests for log_weight_decay
#19805
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.
What does this PR do?
Fixes #19798.
Adds a description for the
log_weight_decay
argument forLearningRateMonitor
, fixes another miscellaneous typo in the docs for that class, and adds an additionalassert
statement to the tests forLearningRateMonitor
to ensure no weight decay values are tracked iflog_weight_decay=False
(by analogy with the tests for (log_momentum=False
).Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--19805.org.readthedocs.build/en/19805/