Skip to content

Commit 93be63a

Browse files
committed
clarify some docs
1 parent 180a5a0 commit 93be63a

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lightning/pytorch/callbacks/model_checkpoint.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,10 @@ class ModelCheckpoint(Checkpoint):
133133
will only save checkpoints at epochs 0 < E <= N
134134
where both values for ``every_n_epochs`` and ``check_val_every_n_epoch`` evenly divide E.
135135
save_on_train_epoch_end: Whether to run checkpointing at the end of the training epoch.
136-
If ``False``, then the check runs at the end of the validation.
137-
If ``None`` and ``check_val_every_n_epoch != 1``, checkpointing will not be performed at the end of
136+
If ``True``, checkpoints are saved at the end of every training epoch.
137+
If ``False``, checkpoints are saved at the end of validation.
138+
If ``None`` (default), checkpointing behavior is determined based on training configuration.
139+
If ``check_val_every_n_epoch != 1``, checkpointing will not be performed at the end of
138140
every training epoch. If there are no validation batches of data, checkpointing will occur at the
139141
end of the training epoch. If there is a non-default number of validation runs per training epoch
140142
(``val_check_interval != 1``), checkpointing is performed after validation.

0 commit comments

Comments
 (0)