bencher.results.histogram_result
================================

.. py:module:: bencher.results.histogram_result


Classes
-------

.. autoapisummary::

   bencher.results.histogram_result.HistogramResult


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

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

   Bases: :py:obj:`bencher.results.holoview_results.holoview_result.HoloviewResult`


   .. py:method:: to_plot(result_var: param.Parameter | None = None, target_dimension: int = 2, **kwargs) -> panel.pane.Pane | None

      Generates a histogram plot from benchmark data.

      This method applies filters to ensure the data is appropriate for a histogram
      and then passes the filtered data to to_histogram_ds for rendering.

      :param result_var: The result variable to plot. If None, uses the default.
      :type result_var: Parameter, optional
      :param target_dimension: The target dimensionality for data filtering. Defaults to 2.
      :type target_dimension: int, optional
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.

      :returns:

                A panel containing the histogram if data is appropriate,
                                      otherwise returns filter match results.
      :rtype: pn.pane.Pane | None



   .. py:method:: _make_histogram(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs)

      Render a single histogram from a dataset (no over_time handling).



   .. py:method:: to_histogram_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs)

      Creates a histogram from the provided dataset.

      Given a filtered dataset, this method generates a histogram visualization showing
      the distribution of values for the result variable. When over_time is active with
      multiple time points, produces per-time-point and pooled-aggregate tabs.

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

      :returns: A histogram visualization of the benchmark data distribution.
      :rtype: hvplot.element.Histogram