Skip to content

Updated ModelCheckpoint callback documentation #6873

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 5 commits into from
Apr 28, 2021
Merged

Updated ModelCheckpoint callback documentation #6873

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95f90df
Updated model_checkpoint documentation
george-gca Feb 23, 2021
f6574ad
Merge branch 'master' into doc/model_checkpoint
carmocca Apr 7, 2021
046cef0
Added recommended changes from #6873
george-gca Apr 26, 2021
1661863
Merge branch 'master' into doc/model_checkpoint
awaelchli Apr 27, 2021
ae39828
Merge branch 'master' into doc/model_checkpoint
carmocca Apr 28, 2021
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
5 changes: 4 additions & 1 deletion pytorch_lightning/callbacks/model_checkpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@

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.
Expand Down