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

Add warnings regarding unsupported keys in optim config and OneCycleLR #9666

Merged
merged 7 commits into from
Oct 4, 2021
Merged

Add warnings regarding unsupported keys in optim config and OneCycleLR #9666

merged 7 commits into from
Oct 4, 2021

Conversation

kingyiusuen
Copy link
Contributor

@kingyiusuen kingyiusuen commented Sep 23, 2021

What does this PR do?

Fixes #9630

  • Added a warning when unsupported keys are found in a optimizer config dict.
  • Added a warning when a OneCycleLR scheduler is used and "interval" is "epoch".

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved 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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

pytorch_lightning/trainer/optimizers.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/optimizers.py Outdated Show resolved Hide resolved
@awaelchli awaelchli added the feature Is an improvement or enhancement label Sep 28, 2021
@awaelchli awaelchli added this to the v1.5 milestone Sep 28, 2021
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

LGTM
users may not know how to turn off the warning

@mergify mergify bot added the ready PRs ready to be merged label Oct 3, 2021
@rohitgr7 rohitgr7 enabled auto-merge (squash) October 4, 2021 08:04
@codecov
Copy link

codecov bot commented Oct 4, 2021

Codecov Report

Merging #9666 (9f6d5a7) into master (4bebf82) will decrease coverage by 4%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #9666    +/-   ##
=======================================
- Coverage      93%     89%    -4%     
=======================================
  Files         179     179            
  Lines       15305   15319    +14     
=======================================
- Hits        14197   13598   -599     
- Misses       1108    1721   +613     

@rohitgr7 rohitgr7 merged commit 6d53037 into Lightning-AI:master Oct 4, 2021
@kingyiusuen kingyiusuen deleted the feature/9630-lr-scheduler-warning branch October 6, 2021 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Is an improvement or enhancement ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve LR Schedulers doc
6 participants