bencher.results.holoview_results.curve_result
=============================================

.. py:module:: bencher.results.holoview_results.curve_result


Classes
-------

.. autoapisummary::

   bencher.results.holoview_results.curve_result.CurveResult


Module Contents
---------------

.. py:class:: CurveResult(bench_cfg: bencher.bench_cfg.BenchCfg)

   Bases: :py:obj:`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.


   .. py:method:: to_plot(**kwargs) -> holoviews.Curve | None

      Generates a curve plot. See ``to_curve`` for parameters.



   .. py:method:: to_curve(result_var: param.Parameter | None = None, override: bool = True, **kwargs) -> holoviews.Curve | None

      Generates a curve plot from benchmark data.

      :param result_var: The result variable to plot.
      :type result_var: Parameter, optional
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool, optional
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.

      :returns: A curve plot, or filter match results.
      :rtype: hv.Curve | None



   .. py:method:: 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.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The result variable to plot.
      :type result_var: Parameter
      :param \*\*kwargs: Additional keyword arguments passed to the curve plot options.

      :returns: A curve plot with optional standard deviation spread.
      :rtype: hv.Curve | None