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 on_exception to DataModule #19601

Merged
merged 4 commits into from
Mar 22, 2024

Conversation

clumsy
Copy link
Contributor

@clumsy clumsy commented Mar 8, 2024

What does this PR do?

Adds on_exception callback that lets us handle training termination due to an exception for LightningDataModule, which is currently not available.

Fixes #19594

The change is backward-compatible, but could be breaking if a type derived from LightningDataModule defines on_exception method.

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--19601.org.readthedocs.build/en/19601/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Mar 8, 2024
@clumsy
Copy link
Contributor Author

clumsy commented Mar 8, 2024

Please let me know if additional changes are necessary, @awaelchli

@awaelchli awaelchli added feature Is an improvement or enhancement trainer community This PR is from the community labels Mar 9, 2024
@awaelchli awaelchli added this to the 2.3 milestone Mar 9, 2024
@awaelchli awaelchli changed the title fix: Add on_exception to DataModule (#19594) Add on_exception to DataModule Mar 9, 2024
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.

Hey @clumsy

The implementation looks good! Thanks for adding the test.

src/lightning/pytorch/CHANGELOG.md Outdated Show resolved Hide resolved
@clumsy clumsy force-pushed the fix/datamodule_on_exception branch from 7e2b99e to 6fbba9a Compare March 11, 2024 14:22
@mergify mergify bot added the ready PRs ready to be merged label Mar 13, 2024
Copy link

codecov bot commented Mar 22, 2024

Codecov Report

Merging #19601 (cfcb55e) into master (6cfc590) will decrease coverage by 31%.
The diff coverage is 100%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #19601      +/-   ##
==========================================
- Coverage      84%      53%     -31%     
==========================================
  Files         424      416       -8     
  Lines       34910    34759     -151     
==========================================
- Hits        29340    18438   -10902     
- Misses       5570    16321   +10751     

@awaelchli awaelchli merged commit d5a9b77 into Lightning-AI:master Mar 22, 2024
87 checks passed
@clumsy clumsy deleted the fix/datamodule_on_exception branch March 22, 2024 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from the community feature Is an improvement or enhancement pl Generic label for PyTorch Lightning package ready PRs ready to be merged trainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Notify LightningDataModule on exception
5 participants