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

Update LearningRateMonitor docs and tests to mention log_weight_decay. #19805

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Peiffap
Copy link

@Peiffap Peiffap commented Apr 23, 2024

What does this PR do?

Fixes #19798.

Adds a description for the log_weight_decay argument for LearningRateMonitor, fixes another miscellaneous typo in the docs for that class, and adds an additional assert statement to the tests for LearningRateMonitor to ensure no weight decay values are tracked if log_weight_decay=False (by analogy with the tests for (log_momentum=False).

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

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
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--19805.org.readthedocs.build/en/19805/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for the log_weight_decay argument in lightning.pytorch.callbacks.LearningRateMonitor
1 participant