Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix misleading ModelCheckpoint documentation on every_n_epochs parameter (#10421)

This commit is contained in:
Adam Reeve 2021-11-20 06:26:50 +13:00 committed by GitHub
parent 5d748e560b
commit 5fe0dac119
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pytorch_lightning/callbacks/model_checkpoint.py
View File

@ -114,8 +114,14 @@ class ModelCheckpoint(Callback):
guaranteed to execute at the exact time specified, but should be close.
This must be mutually exclusive with ``every_n_train_steps`` and ``every_n_epochs``.
every_n_epochs: Number of epochs between checkpoints.
If ``every_n_epochs == None or every_n_epochs == 0``, we skip saving when the epoch ends.
To disable, set ``every_n_epochs = 0``. This value must be ``None`` or non-negative.
This value must be ``None`` or non-negative.
To disable saving after each epoch, set ``every_n_epochs = 0``.
If all of ``every_n_epochs``, ``every_n_train_steps`` and
``train_time_interval`` are ``None``, we save a checkpoint at the end of every epoch
(equivalent to ``every_n_epochs = 1``).
If ``every_n_epochs == None`` and either ``every_n_train_steps != None`` or ``train_time_interval != None``,
saving at the end of each epoch is disabled
(equivalent to ``every_n_epochs = 0``).
This must be mutually exclusive with ``every_n_train_steps`` and ``train_time_interval``.
Setting both ``ModelCheckpoint(..., every_n_epochs=V, save_on_train_epoch_end=False)`` and
``Trainer(max_epochs=N, check_val_every_n_epoch=M)``