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

Raise a MisconfigurationException when trainer functions are called with ckpt_path="best" but checkpoint_callback isn't configured #9841

Merged
merged 5 commits into from
Oct 12, 2021

Conversation

rohitgr7
Copy link
Contributor

@rohitgr7 rohitgr7 commented Oct 6, 2021

What does this PR do?

Right now if checkpoint callback is not configured and you do trainer.test(ckpt_path='best') then it raises:

'NoneType' object has no attribute 'best_model_path'

this is a bit confusing maybe, so just added a check to look for checkpoint callback first

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 🙃

@rohitgr7 rohitgr7 added the feature Is an improvement or enhancement label Oct 6, 2021
@rohitgr7 rohitgr7 added this to the v1.5 milestone Oct 6, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 6, 2021

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

@codecov
Copy link

codecov bot commented Oct 6, 2021

Codecov Report

Merging #9841 (71e45e3) into master (f16bfe9) will decrease coverage by 4%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #9841    +/-   ##
=======================================
- Coverage      93%     89%    -4%     
=======================================
  Files         178     178            
  Lines       15647   15649     +2     
=======================================
- Hits        14502   13895   -607     
- Misses       1145    1754   +609     

@ananthsub ananthsub added the checkpointing Related to checkpointing label Oct 6, 2021
pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
@mergify mergify bot added the has conflicts label Oct 7, 2021
@mergify mergify bot removed the has conflicts label Oct 12, 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 ! Nice catch :)

pytorch_lightning/trainer/trainer.py Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Oct 12, 2021
@rohitgr7 rohitgr7 changed the title Add a check to look for checkpoint_callback if ckpt_path='best' Raise a MisconfigurationException when trainer functions are called with ckpt_path="best" but checkpoint_callback isn't configured Oct 12, 2021
@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 merged commit f2b0db6 into master Oct 12, 2021
@rohitgr7 rohitgr7 deleted the enhance/tr_test branch October 12, 2021 10:05
rohitgr7 added a commit to Tshimanga/pytorch-lightning that referenced this pull request Oct 18, 2021
… with `ckpt_path="best"` but `checkpoint_callback` isn't configured (Lightning-AI#9841)

* add check

* chlog

* Apply suggestions from code review

Co-authored-by: ananthsub <[email protected]>

* Apply suggestions from code review

Co-authored-by: thomas chaton <[email protected]>

Co-authored-by: ananthsub <[email protected]>
Co-authored-by: thomas chaton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
checkpointing Related to checkpointing feature Is an improvement or enhancement ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants