Skip to content

Add on_exception callback hook #9183

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

Merged
merged 10 commits into from
Sep 1, 2021
Merged

Conversation

daniellepintz
Copy link
Contributor

@daniellepintz daniellepintz commented Aug 29, 2021

What does this PR do?

Create an on_exception callback hook that users can override to implement custom behavior when an exception occurs.

Fixes #8992

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 🙃

Copy link
Contributor

@ananthsub ananthsub left a comment

Choose a reason for hiding this comment

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

To keep the PRs single-focused, I'd recommend splitting this into:

  1. 1 PR to add the on_exception hook
  2. 1 PR to deprecate on_keyboard_interrupt in favor of on_exception

@daniellepintz
Copy link
Contributor Author

thanks for the review @ananthsub! I separated the PRs with daniellepintz#1

@mergify mergify bot added the ready PRs ready to be merged label Aug 30, 2021
Copy link
Contributor

@ananthsub ananthsub left a comment

Choose a reason for hiding this comment

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

please check the test failures. we'll need to add this hook to the Lambda Callback as well: https://github.com/PyTorchLightning/pytorch-lightning/blob/master/pytorch_lightning/callbacks/lambda_function.py

@daniellepintz
Copy link
Contributor Author

@ananthsub tests are fixed now!

@codecov
Copy link

codecov bot commented Aug 30, 2021

Codecov Report

Merging #9183 (05f6bef) into master (1657588) will decrease coverage by 4%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #9183    +/-   ##
=======================================
- Coverage      92%     88%    -4%     
=======================================
  Files         176     176            
  Lines       14877   14831    -46     
=======================================
- Hits        13723   13064   -659     
- Misses       1154    1767   +613     

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.

great stuff!

Borda
Borda previously requested changes Aug 31, 2021
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

need clarification on deprecation other interrupt and better spec loop from which the exception is coming from

@mergify mergify bot removed the ready PRs ready to be merged label Aug 31, 2021
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.

LGTM ! small question.

@tchaton tchaton enabled auto-merge (squash) September 1, 2021 08:36
@tchaton tchaton merged commit b046bd0 into Lightning-AI:master Sep 1, 2021
@mergify mergify bot added the ready PRs ready to be merged label Sep 1, 2021
@carmocca carmocca added this to the v1.5 milestone Sep 1, 2021
@daniellepintz daniellepintz deleted the on_exception branch September 10, 2021 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
callback ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow users to provide custom exception handling
6 participants