bencher.results.holoview_results.line_result

Classes

LineResult

A class for creating line plot visualizations from benchmark results.

Module Contents

class bencher.results.holoview_results.line_result.LineResult(bench_cfg: bencher.bench_cfg.BenchCfg)

Bases: bencher.results.holoview_results.holoview_result.HoloviewResult

A class for creating line plot visualizations from benchmark results.

Line plots are effective for visualizing trends in data over a continuous variable. This class provides methods to generate interactive line plots from benchmark data, with options for adding interactive tap functionality to display detailed information about specific data points.

to_plot(**kwargs) → panel.panel | None

Generates a line plot. See to_line for parameters.

to_line(result_var: param.Parameter | None = None, tap_var=None, tap_container: panel.pane.panel = None, target_dimension=2, override: bool = True, use_tap: bool = _USE_TAP, **kwargs) → panel.panel | None

Generates a line plot from benchmark data.

Parameters:

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

  • tap_var – Variables to display when tapping on line plot points.

  • tap_container (pn.pane.panel, optional) – Container to hold tapped information.

  • target_dimension (int, optional) – Target dimensionality for the plot. Defaults to 2.

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

  • use_tap (bool, optional) – Whether to enable tap functionality.

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

Returns:

A panel containing the line plot, or filter match results.

Return type:

pn.panel | None

to_line_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs)

Creates a basic line plot from the provided dataset.

When over_time is active with multiple time points, creates an hv.HoloMap with a slider.

Parameters:

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

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

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

Returns:

A line plot visualization.

Return type:

hvplot.element.Curve | pn.Column

_to_line_tap_ds(dataset: xarray.Dataset, result_var: param.Parameter, result_var_plots: list[param.Parameter] | None = None, container: panel.pane.panel = pn.pane.panel, **kwargs) → panel.Row

Creates an interactive line plot with tap functionality.

Parameters:

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

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

  • result_var_plots (list[Parameter], optional) – Additional result variables to display when a point is tapped.

  • container (pn.pane.panel, optional) – Container to display tapped information.

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

Returns:

A panel row containing the interactive line plot and tap info.

Return type:

pn.Row