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

Fix ModelCheckpoint misformats filename #17610

Merged
merged 4 commits into from
May 12, 2023

Conversation

bkiat1123
Copy link
Contributor

@bkiat1123 bkiat1123 commented May 11, 2023

What does this PR do?

As reported in this issue, filename format failed when one metric key is substring of another.

filename = "{epoch:03d}-{epoch_test:03d}"
groups = re.findall(r"(\{.*?)[:\}]", filename)
for group in groups:
    filename = filename.replace(group, ...)

In the first iteration of the for loop, both epoch and epoch_test will be formatted, which cause the error. Solve by reverse sorting the keys by length.

Fixes #16290

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

So when key a is a substring of key b, key b will be replaced first.
re.findall will always return a list, which will always have length >= 0.
If groups is empty list, the for loop simply will be skipped.
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label May 11, 2023
@awaelchli awaelchli added the community This PR is from the community label May 12, 2023
@mergify mergify bot added the ready PRs ready to be merged label May 12, 2023
@awaelchli awaelchli added this to the v1.9.x milestone May 12, 2023
@awaelchli awaelchli added bug Something isn't working callback: model checkpoint labels May 12, 2023
@awaelchli awaelchli merged commit cbc536a into Lightning-AI:master May 12, 2023
79 checks passed
@bkiat1123 bkiat1123 deleted the fix_format_checkpoint_name branch May 13, 2023 09:03
Borda pushed a commit that referenced this pull request Jun 2, 2023
Co-authored-by: awaelchli <aedu.waelchli@gmail.com>

(cherry picked from commit cbc536a)
Borda pushed a commit that referenced this pull request Jun 2, 2023
Co-authored-by: awaelchli <aedu.waelchli@gmail.com>

(cherry picked from commit cbc536a)
lantiga pushed a commit that referenced this pull request Jun 2, 2023
Co-authored-by: awaelchli <aedu.waelchli@gmail.com>

(cherry picked from commit cbc536a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working callback: model checkpoint community This PR is from the community 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 misformats filename if keys have shared substrings
3 participants