aspire.plot
===========

.. py:module:: aspire.plot


Functions
---------

.. autoapisummary::

   aspire.plot.plot_comparison
   aspire.plot.plot_history_comparison


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

.. py:function:: plot_comparison(*samples, parameters = None, per_samples_kwargs = None, labels = None, **kwargs)

   Plot a comparison of multiple samples.

   :param samples: The samples to compare.
   :type samples: :py:class:`Samples`
   :param parameters: The list of parameter names to plot. If None, the parameters will be
                      inferred from the samples.
   :type parameters: :py:class:`list[str] | None`
   :param per_samples_kwargs: A list of dictionaries of keyword arguments to pass to each sample's
                              :code:`plot_corner` method. If None, no additional keyword arguments
                              will be passed. If provided, must have the same length as samples
   :type per_samples_kwargs: :py:class:`list[dict] | None`
   :param labels: A list of labels for the legend. If None, no legend will be shown. If
                  provided, must have the same length as samples.
   :type labels: :py:class:`list[str] | None`
   :param kwargs: Additional keyword arguments to pass to each sample's
                  :code:`plot_corner` method.
   :type kwargs: :py:class:`dict`


.. py:function:: plot_history_comparison(*histories)