feat: add best_model_metrics to ModelCheckpoint callback #21355
+78
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR introduces a new
best_model_metricsattribute to the ModelCheckpoint callback, enabling users to directly access all logged training and validation metrics associated with the best model, chosen based on the monitored metric.Previously, only the
best_model_scoreandbest_model_pathwere available. With this addition, users can easily retrieve the corresponding metrics like val_loss, train_loss, val_metric etc. of the best checkpoint without reloading the model or rerunning validation.This makes it easier to analyze results and use the best model’s metrics for reporting or hyperparameter tuning.
Fixes #19007
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--21355.org.readthedocs.build/en/21355/