-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
awaelchli
merged 8 commits into
Lightning-AI:master
from
adosar:docs/20130_ModelCheckpoint
Aug 4, 2024
Merged
Docs: Add note about version counter in ModelCheckpoint
#20146
awaelchli
merged 8 commits into
Lightning-AI:master
from
adosar:docs/20130_ModelCheckpoint
Aug 4, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`.
adosar
requested review from
lantiga,
Borda,
tchaton,
awaelchli and
justusschock
as code owners
July 31, 2024 15:33
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #20146 +/- ##
=========================================
- Coverage 89% 81% -8%
=========================================
Files 267 264 -3
Lines 23045 22990 -55
=========================================
- Hits 20547 18583 -1964
- Misses 2498 4407 +1909 |
Borda
approved these changes
Aug 2, 2024
awaelchli
reviewed
Aug 3, 2024
awaelchli
added
docs
Documentation related
community
This PR is from the community
callback: model checkpoint
labels
Aug 3, 2024
Concise docs enhancement for #20130 Co-authored-by: awaelchli <[email protected]>
awaelchli
approved these changes
Aug 4, 2024
awaelchli
changed the title
Docs enhancement for
Docs: Add note about version counter in Aug 4, 2024
ModelCheckpoint
ModelCheckpoint
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 tofilename
.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
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
📚 Documentation preview 📚: https://pytorch-lightning--20146.org.readthedocs.build/en/20146/