summarize#

EstimatorReport.checks.summarize(*, ignore=None, fast_mode=False)[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"].
fast_modebool, default=False: When True, skip the expensive checks that are not already in the cache. Cached slow results from a previous call are still surfaced.

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)
>>> summary = report.checks.summarize()
>>> "SKD002" in summary.frame()["code"].values
True
>>> filtered = report.checks.summarize(ignore=["SKD002"])
>>> "SKD002" in filtered.frame()["code"].values
False