docs: remove duplicate and incorrect filename entry in ModelCheckpoint docstring - #21876
Open
Kropiunig wants to merge 1 commit into
Open
Conversation
Kropiunig
requested review from
ethanwharris,
justusschock and
tchaton
as code owners
August 4, 2026 06:06
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
filenameargument is documented twice in theModelCheckpointArgs docstring. The first entry is a broken duplicate: it says the default is saved to{epoch}and contains the malformed fragment "{epoch}.and if the Trainer..." (missing space and a stray period mid-sentence). The default is actually'{epoch}-{step}'(built from"{epoch}"+CHECKPOINT_JOIN_CHAR+"{step}"), which the secondfilenameentry already documents correctly. This removes the redundant, incorrect first entry and keeps the correct one as the single source of truth.