Skip to content

Commit e272bea

Browse files
george-gcacarmoccaawaelchli
authored
Updated ModelCheckpoint documentation (#6873)
Co-authored-by: Carlos Mocholi <[email protected]> Co-authored-by: Adrian Wälchli <[email protected]>
1 parent b0cd9da commit e272bea

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pytorch_lightning/callbacks/model_checkpoint.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@
4141

4242
class ModelCheckpoint(Callback):
4343
r"""
44-
Save the model after every epoch by monitoring a quantity.
44+
Save the model periodically by monitoring a quantity. Every metric logged with
45+
:meth:`~pytorch_lightning.core.lightning.log` or :meth:`~pytorch_lightning.core.lightning.log_dict` in
46+
LightningModule is a candidate for the monitor key. For more information, see
47+
:ref:`weights_loading`.
4548
4649
After training finishes, use :attr:`best_model_path` to retrieve the path to the
4750
best checkpoint file and :attr:`best_model_score` to retrieve its score.

0 commit comments

Comments
 (0)