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

[feat] Add stronger validation for checkpoint_callback argument #7539

Merged
merged 8 commits into from
May 19, 2021

Conversation

ananthsub
Copy link
Contributor

@ananthsub ananthsub commented May 14, 2021

What does this PR do?

This removes the option for passing a ModelCheckpoint instance to the checkpoint_callback argument and raises an error if the wrong type is provided.

This argument is already typed as bool in the Trainer, but the callback connector was accepting Union[bool, ModelCheckpoint]. This can be very confusing for users who pass model checkpoint callback instances to this argument, as their callback settings are silently ignored.

This carries forward the deprecation initially landed in #4336

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

Did you have fun?

Make sure you had fun coding 🙃

@pep8speaks
Copy link

pep8speaks commented May 14, 2021

Hello @ananthsub! Thanks for updating this PR.

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

Comment last updated at 2021-05-17 17:59:38 UTC

@ananthsub ananthsub added this to the v1.4 milestone May 14, 2021
@ananthsub ananthsub added callback checkpointing Related to checkpointing refactor labels May 14, 2021
@codecov
Copy link

codecov bot commented May 14, 2021

Codecov Report

Merging #7539 (23e92fd) into master (233f252) will decrease coverage by 4%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #7539    +/-   ##
=======================================
- Coverage      92%     88%    -4%     
=======================================
  Files         196     197     +1     
  Lines       12835   12884    +49     
=======================================
- Hits        11832   11318   -514     
- Misses       1003    1566   +563     

@ananthsub ananthsub changed the title [feat] Add stronger validation for checkpoint_callback configuration [feat] Add stronger validation for checkpoint_callback argument May 14, 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.

nice!

@carmocca carmocca added the ready PRs ready to be merged label May 17, 2021
@ananthsub ananthsub enabled auto-merge (squash) May 17, 2021 19:58
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.

LGMT !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
callback checkpointing Related to checkpointing ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants