MetricsSummaryDisplay#

class skore.MetricsSummaryDisplay(summarize_data)[source]#

Display for summarize.

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

frame()[source]#

Return the summarize as a dataframe.

Returns:
framepandas.DataFrame

The report metrics as a dataframe.

help()[source]#

Display available attributes and methods using rich.

set_style(**kwargs)[source]#

Set the style parameters for the display.

Parameters:
**kwargsdict

Style parameters to set. Each parameter name should correspond to a a style attribute passed to the plot method of the display.

Returns:
selfobject

Returns the instance itself.

Raises:
ValueError

If a style parameter is unknown.

static style_plot(plot_func)[source]#

Apply consistent style to skore displays.

This decorator: 1. Applies default style settings 2. Executes plot_func 3. Applies tight_layout

Parameters:
plot_funccallable

The plot function to be decorated.

Returns:
callable

The decorated plot function.