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 warnings in TrainingTricksConnector #9595

Merged
merged 6 commits into from
Sep 25, 2021
Merged

Update warnings in TrainingTricksConnector #9595

merged 6 commits into from
Sep 25, 2021

Conversation

rohitgr7
Copy link
Contributor

@rohitgr7 rohitgr7 commented Sep 18, 2021

What does this PR do?

Improved some warnings and checks since there is some ambiguity.

>>> GradClipAlgorithmType.NORM == 'Norm'  # weird
True

>>> 'Norm' in list(GradClipAlgorithmType)  # weird
True

>>> GradClipAlgorithmType('Norm')   # okay
ValueError: 'Norm' is not a valid GradClipAlgorithmType

>>> Trainer(gradient_clip_algorithm = 'Norm')  # not a good warning
ValueError: 'Norm' is not a valid GradClipAlgorithmType
    
>>> Trainer(gradient_clip_algorithm = 'something_else')   # not user-friendly
gradient_clip_algorithm should be in [<GradClipAlgorithmType.VALUE: 'value'>, <GradClipAlgorithmType.NORM: 'norm'>]

Now both 'Norm' and 'norm' are valid

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?

ezgif com-gif-maker

@github-actions
Copy link
Contributor

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@rohitgr7 rohitgr7 added this to the v1.4.x milestone Sep 24, 2021
@codecov
Copy link

codecov bot commented Sep 24, 2021

Codecov Report

Merging #9595 (605c07f) into master (c66d30a) will increase coverage by 1%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #9595    +/-   ##
=======================================
+ Coverage      92%     93%    +1%     
=======================================
  Files         181     179     -2     
  Lines       15728   15317   -411     
=======================================
- Hits        14446   14209   -237     
+ Misses       1282    1108   -174     

tests/trainer/test_trainer.py Outdated Show resolved Hide resolved
tests/trainer/test_trainer.py Outdated Show resolved Hide resolved
@rohitgr7 rohitgr7 requested a review from carmocca September 24, 2021 13:52
@mergify mergify bot added the ready PRs ready to be merged label Sep 24, 2021
@rohitgr7 rohitgr7 enabled auto-merge (squash) September 24, 2021 14:21
@rohitgr7 rohitgr7 merged commit a4bc0ac into master Sep 25, 2021
@rohitgr7 rohitgr7 deleted the ref/gclip_warn branch September 25, 2021 16:02
speediedan pushed a commit to speediedan/lightning that referenced this pull request Sep 28, 2021
* update warnings

* add tests

* comments

* Apply suggestions from code review

* Apply suggestions from code review
@awaelchli awaelchli added the bug Something isn't working label Sep 29, 2021
awaelchli added a commit that referenced this pull request Sep 29, 2021
awaelchli added a commit that referenced this pull request Sep 29, 2021
lexierule pushed a commit that referenced this pull request Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants