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 an option to overwrite the existing checkpoint file #17320

Merged
merged 14 commits into from
May 3, 2023

Conversation

solyaH
Copy link
Contributor

@solyaH solyaH commented Apr 10, 2023

What does this PR do?

If you want to preserve the checkpoint's file name, you can now specify override_existing=True on the ModelCheckpoint constructor. It will lead to overwriting the file path instead of writing a new file with the version appended.
Fixes #15106

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

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Apr 10, 2023
@solyaH solyaH marked this pull request as ready for review April 10, 2023 17:36
@awaelchli awaelchli added feature Is an improvement or enhancement callback: model checkpoint community This PR is from the community labels Apr 11, 2023
carmocca

This comment was marked as off-topic.

@Borda Borda requested review from awaelchli, carmocca and Borda April 14, 2023 08:19
@solyaH solyaH requested review from carmocca and Borda April 28, 2023 15:36
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

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

Can you add a CHANGELOG.md entry, please?

tests/tests_pytorch/checkpointing/test_model_checkpoint.py Outdated Show resolved Hide resolved
@mergify mergify bot added the has conflicts label May 3, 2023
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

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

Awesome!

@carmocca carmocca assigned carmocca and unassigned awaelchli May 3, 2023
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels May 3, 2023
@carmocca carmocca enabled auto-merge (squash) May 3, 2023 11:39
@mergify mergify bot added the ready PRs ready to be merged label May 3, 2023
@carmocca carmocca merged commit 04a86f9 into Lightning-AI:master May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
callback: model checkpoint 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ModelCheckpoint callback should [have the option to] override existing .ckpt when name matches existing file
4 participants