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

Document exceptions in callbacks #5541

Merged
merged 31 commits into from
Feb 15, 2021

Conversation

akihironitta
Copy link
Contributor

@akihironitta akihironitta commented Jan 16, 2021

What does this PR do?

Part of #5434.

TODO

  • base.py
  • early_stopping.py
  • finetuning.py
  • gpu_stats_monitor.py
  • gradient_accumulation_scheduler.py
  • __init__.py
  • lambda_function.py
  • lr_monitor.py
  • model_checkpoint.py
  • progress.py
  • pruning.py

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 update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
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
  • Check that target branch and milestone match!

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Jan 16, 2021

Codecov Report

Merging #5541 (9f43a89) into master (52c07f2) will decrease coverage by 3%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #5541    +/-   ##
=======================================
- Coverage      90%     88%    -3%     
=======================================
  Files         170     170            
  Lines       11807   11650   -157     
=======================================
- Hits        10676   10215   -461     
- Misses       1131    1435   +304     

@Borda Borda added the docs Documentation related label Jan 19, 2021
@carmocca
Copy link
Contributor

You may want to use the issue as a tracker of all the lines and do it on separate PRs. This also allows external contributors

@akihironitta akihironitta changed the title Document exceptions Document exceptions in callbacks Jan 19, 2021
@akihironitta akihironitta mentioned this pull request Jan 19, 2021
22 tasks
pytorch_lightning/callbacks/finetuning.py Outdated Show resolved Hide resolved
pytorch_lightning/callbacks/pruning.py Show resolved Hide resolved
pytorch_lightning/callbacks/pruning.py Show resolved Hide resolved
Base automatically changed from release/1.2-dev to master February 11, 2021 14:32
@mergify mergify bot removed the has conflicts label Feb 12, 2021
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
@pep8speaks
Copy link

pep8speaks commented Feb 12, 2021

Hello @akihironitta! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-02-15 00:02:26 UTC

@akihironitta
Copy link
Contributor Author

Would you mind reviewing this PR again?

@Borda Borda added the ready PRs ready to be merged label Feb 12, 2021
@Borda Borda enabled auto-merge (squash) February 12, 2021 08:00
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

Great addition !

@Borda Borda merged commit 0a2fb05 into Lightning-AI:master Feb 15, 2021
@akihironitta akihironitta deleted the docs/add-raises-section branch February 17, 2021 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants