Skip to content

Clarify default epoch and step values in ModelCheckpoint #16651

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 7, 2023
Merged

Clarify default epoch and step values in ModelCheckpoint #16651

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/lightning/pytorch/callbacks/model_checkpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ class ModelCheckpoint(Checkpoint):
... filename='{epoch}-{val_loss:.2f}-{other_metric:.2f}'
... )

By default, filename is ``None`` and will be set to ``'{epoch}-{step}'``.
By default, filename is ``None`` and will be set to ``'{epoch}-{step}'``, where "epoch" and "step" match
the number of finished epoch and optimizer steps respectively.
monitor: quantity to monitor. By default it is ``None`` which saves a checkpoint only for the last epoch.
verbose: verbosity mode. Default: ``False``.
save_last: When ``True``, saves an exact copy of the checkpoint to a file `last.ckpt` whenever a checkpoint
Expand Down