Clarify requirements for `Trainer.fit(ckpt_path="last")` (#19066)

This commit is contained in:
Adrian Wälchli 2023-11-27 17:03:45 +01:00 committed by GitHub
parent 482da0a140
commit 9d366046b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

View File

@ -41,10 +41,10 @@ To run the test set after training completes, use this method.
# run full training
trainer.fit(model)
# (1) load the best checkpoint automatically (lightning tracks this for you)
# (1) load the best checkpoint automatically (lightning tracks this for you during .fit())
trainer.test(ckpt_path="best")
# (2) load the last available checkpoint
# (2) load the last available checkpoint (only works if `ModelCheckpoint(save_last=True)`)
trainer.test(ckpt_path="last")
# (3) test using a specific checkpoint

View File

@ -185,7 +185,7 @@ class _CheckpointConnector:
# not an error so it can be set and forget before the first `fit` run
rank_zero_warn(
f'.{fn}(ckpt_path="last") is set, but there is no last checkpoint available.'
" No checkpoint will be loaded."
" No checkpoint will be loaded. HINT: Set `ModelCheckpoint(..., save_last=True)`."
)
return None
ckpt_path = max(candidates_ts, key=candidates_ts.get) # type: ignore[arg-type]