summarize#

CrossValidationReport.checks.summarize(*, ignore=None)[source]#

Run checks and return a summary with detected issues.

Checks look for common modeling problems such as overfitting and underfitting. Check codes can be muted per-call via ignore or globally via configuration() with ignore_checks=....

Parameters:

ignorelist of str or tuple of str or None, default=None: Check codes to exclude from the results, e.g. ["SKD001"].

Returns:

ChecksSummaryDisplay: A display object with an HTML representation organized as three tabs (Issues, Tips, Passed). The full list of results is accessible via the frame() method.

Examples

>>> from skore import evaluate
>>> from sklearn.dummy import DummyClassifier
>>> from sklearn.datasets import make_classification
>>> X, y = make_classification(random_state=42)
>>> report = evaluate(DummyClassifier(), X, y, splitter=0.2)
>>> report.checks.summarize()
Checks summary: 1 issue(s), ...
Issues:
- [SKD002] Potential underfitting...
...
>>> report.checks.summarize(ignore=["SKD002"])
Checks summary: 0 issue(s), ... 1 ignored.
...