bencher.results.holoview_results.scatter_result
===============================================

.. py:module:: bencher.results.holoview_results.scatter_result


Classes
-------

.. autoapisummary::

   bencher.results.holoview_results.scatter_result.ScatterResult


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

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

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


   A class for creating scatter plots from benchmark results.

   Scatter plots are useful for visualizing the distribution of individual data points
   and identifying patterns, clusters, or outliers. This class generates scatter plots
   that can be grouped by categorical variables.


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

      Creates a scatter plot. See ``to_scatter`` for parameters.



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

      Creates a standard scatter 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 scatter plot options.

      :returns: A panel containing the scatter plot, or filter match results.
      :rtype: pn.panel | None



   .. py:method:: _to_scatter_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs) -> panel.panel | None

      Creates a scatter plot from the provided dataset.

      :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 scatter plot.

      :returns: A scatter plot visualization.
      :rtype: pn.panel | None