bencher.results.holoview_results.curve_result

Classes

CurveResult

A class for creating curve plots with optional standard-deviation spread.

Module Contents

class bencher.results.holoview_results.curve_result.CurveResult(bench_cfg: bencher.bench_cfg.BenchCfg)

Bases: bencher.results.holoview_results.holoview_result.HoloviewResult

A class for creating curve plots with optional standard-deviation spread.

Curve plots show the relationship between a continuous input variable and a result variable. When multiple benchmark repetitions are available, standard deviation bounds are displayed using an hv.Spread overlay.

to_plot(**kwargs) → holoviews.Curve | None

Generates a curve plot. See to_curve for parameters.

to_curve(result_var: param.Parameter | None = None, override: bool = True, **kwargs) → holoviews.Curve | None

Generates a curve plot from benchmark data.

Parameters:

  • result_var (Parameter, optional) – The result variable to plot.

  • override (bool, optional) – Whether to override filter restrictions. Defaults to True.

  • **kwargs – Additional keyword arguments passed to the plot rendering.

Returns:

A curve plot, or filter match results.

Return type:

hv.Curve | None

to_curve_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs) → holoviews.Curve | None

Creates a curve plot from the provided dataset.

Generates a curve with optional standard deviation spread overlay.

When over_time is active with multiple time points, builds per-time-point curves inside an hv.HoloMap so the slider controls the time dimension.

Parameters:

  • dataset (xr.Dataset) – The dataset containing benchmark results.

  • result_var (Parameter) – The result variable to plot.

  • **kwargs – Additional keyword arguments passed to the curve plot options.

Returns:

A curve plot with optional standard deviation spread.

Return type:

hv.Curve | None