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

Updated `ModelCheckpoint` documentation (#6873) 

Co-authored-by: Carlos Mocholi <carlossmocholi@gmail.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
This commit is contained in:
George 2021-04-28 20:56:58 -03:00 committed by GitHub
parent b0cd9daf25
commit e272bea4dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pytorch_lightning/callbacks/model_checkpoint.py
View File

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