simopt.plots.terminal_scatterplot
=================================

.. py:module:: simopt.plots.terminal_scatterplot

.. autoapi-nested-parse::

   Terminal scatter plot.





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

.. py:function:: plot_terminal_scatterplots(experiments: list[list[simopt.experiment.ProblemSolver]], all_in_one: float = True, plot_title: str | None = None, legend_loc: str | None = None, ext: str = '.png', save_as_pickle: bool = False, solver_set_name: str = 'SOLVER_SET', problem_set_name: str = 'PROBLEM_SET') -> list[pathlib.Path]

   Plot scatter plots of the mean and standard deviation of terminal progress.

   Either creates one plot per solver or a combined plot for all solvers.

   :param experiments: Problem-solver pairs used to produce
                       plots.
   :type experiments: list[list[ProblemSolver]]
   :param all_in_one: Whether to plot all solvers in one figure.
                      Defaults to True.
   :type all_in_one: bool, optional
   :param plot_title: Title to override the autogenerated one
                      (only applies if `all_in_one` is True).
   :type plot_title: str | None, optional
   :param legend_loc: Location of the legend (e.g., "best").
                      Defaults to None.
   :type legend_loc: str | None, optional
   :param ext: File extension to use for output images.
               Defaults to ".png".
   :type ext: str, optional
   :param save_as_pickle: Whether to also save the plots as `.pickle`
                          files. Defaults to False.
   :type save_as_pickle: bool, optional
   :param solver_set_name: Name for the solver group used in plot titles.
                           Defaults to "SOLVER_SET".
   :type solver_set_name: str, optional
   :param problem_set_name: Name for the problem group used in plot
                            titles. Defaults to "PROBLEM_SET".
   :type problem_set_name: str, optional

   :returns: A list of file paths to the plots produced.
   :rtype: list[Path]