ChecksSummaryDisplay#

class skore.ChecksSummaryDisplay(check_results, n_ignored_codes)[source]#

Display for the checks summary.

An instance of this class will be created by summarize().This class should not be instantiated directly.

The display object has an HTML representation organized in three tabs (Issues, Tips, Passed). The full list of check results is accessible via the frame() method.

Parameters:
check_resultsdict of str to dict

Results of applicable checks keyed by check code (e.g. "SKD001"). Each value is a dict with keys "title", "explanation", "severity" ("issue" or "tip"), and optionally "docs_url".

n_ignored_codesint

Number of the checks that were muted via ignore= or the global ignore_checks configuration.

frame(severity='all')[source]#

Return check results as a DataFrame.

Parameters:
severity{“issue”, “tip”, “passed”, “all”}, default=”all”

Which results to include. "issue" / "tip" return only the matching findings (explanation is not None); "passed" returns the checks that ran without reporting anything; "all" returns every applicable check result.

Returns:
pandas.DataFrame

A DataFrame with one row per check and columns "code", "title", "severity", "explanation", and "documentation_url". The "explanation" column is None for checks that passed without reporting anything.

help()[source]#

Display display help using rich or HTML.