bencher.results.holoview_results.bar_result
===========================================

.. py:module:: bencher.results.holoview_results.bar_result


Classes
-------

.. autoapisummary::

   bencher.results.holoview_results.bar_result.BarResult


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

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

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


   A class for creating bar chart visualizations from benchmark results.

   Bar charts are effective for comparing values across categorical variables or
   discrete data points. This class provides methods to generate bar charts that
   display benchmark results, particularly useful for comparing performance metrics
   between different configurations or categories.


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


   .. py:method:: to_bar(result_var: param.Parameter | None = None, override: bool = True, target_dimension: int = 2, **kwargs) -> panel.panel | None

      Generates a bar chart from benchmark data.

      This method applies filters to ensure the data is appropriate for a bar chart
      and then passes the filtered data to to_bar_ds for rendering.

      :param result_var: The result variable to plot. If None, uses the default.
      :type result_var: Parameter, optional
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool, 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 bar chart if data is appropriate,
                                  otherwise returns filter match results.
      :rtype: pn.panel | None



   .. py:method:: to_bar_ds(dataset: xarray.Dataset, result_var: param.Parameter | None = None, **kwargs)

      Creates a bar chart from the provided dataset.

      Given a filtered dataset, this method generates a bar chart visualization showing
      values of the result variable, potentially grouped by categorical variables.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The result variable to plot. If None, uses the default.
      :type result_var: Parameter, optional
      :param \*\*kwargs: Additional keyword arguments passed to the bar chart options.

      :returns: A bar chart visualization of the benchmark data.
      :rtype: hvplot.element.Bars | hv.HoloMap