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

Docs: Add note about version counter in ModelCheckpoint #20146

Merged
merged 8 commits into from
Aug 4, 2024

Conversation

adosar
Copy link
Contributor

@adosar adosar commented Jul 31, 2024

Fixes: #20130

Add a note for the save_top_k parameter, emphasizing that users shouldn't rely on version count to retrieve the best model but instead pass formatting options to filename.

What does this PR do?

Clarifies that users shouldn't rely on version count appended to the filenames of checkpoints for retrieving the best k models.

Fixes #20130

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

Fixes: #20130

Add a note for the `save_top_k` parameter, emphasizing that users
shouldn't rely on version count to retrieve the best model but instead
pass formatting options to `filename`.
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jul 31, 2024
Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81%. Comparing base (194c3c3) to head (e4eaff9).
Report is 3 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (194c3c3) and HEAD (e4eaff9). Click for more details.

HEAD has 90 uploads less than BASE
Flag BASE (194c3c3) HEAD (e4eaff9)
gpu 4 2
pytest 25 2
lightning_fabric 7 0
cpu 42 21
python3.9 12 6
lightning 32 16
python3.10 12 6
python3.11 12 6
python3.12 6 3
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #20146     +/-   ##
=========================================
- Coverage      89%      81%     -8%     
=========================================
  Files         267      264      -3     
  Lines       23044    22989     -55     
=========================================
- Hits        20546    18582   -1964     
- Misses       2498     4407   +1909     

@awaelchli awaelchli added docs Documentation related community This PR is from the community callback: model checkpoint labels Aug 3, 2024
@awaelchli awaelchli added this to the 2.4 milestone Aug 3, 2024
@mergify mergify bot added the ready PRs ready to be merged label Aug 4, 2024
@awaelchli awaelchli changed the title Docs enhancement for ModelCheckpoint Docs: Add note about version counter in ModelCheckpoint Aug 4, 2024
@awaelchli awaelchli merged commit 854d166 into Lightning-AI:master Aug 4, 2024
72 of 73 checks passed
ammyk9 pushed a commit to ammyk9/pytorch-lightning that referenced this pull request Aug 6, 2024
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 docs Documentation related 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.

Documentation for filename convention of save_top_k in ModelCheckpoint
3 participants