simopt.plots.terminal_progress
==============================

.. py:module:: simopt.plots.terminal_progress

.. autoapi-nested-parse::

   Terminal progress plot.





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

.. py:function:: plot_terminal_progress(experiments: list[simopt.experiment.ProblemSolver], plot_type: simopt.plot_type.PlotType = PlotType.VIOLIN, normalize: bool = True, all_in_one: bool = True, plot_title: str | None = None, ext: str = '.png', save_as_pickle: bool = False, solver_set_name: str = 'SOLVER_SET') -> list[pathlib.Path]

   Plots terminal progress as box or violin plots for solvers on a single problem.

   :param experiments: ProblemSolver pairs for different solvers on
                       a common problem.
   :type experiments: list[ProblemSolver]
   :param plot_type: Type of plot to generate: "box" or "violin".
                     Defaults to "violin".
   :type plot_type: str, optional
   :param normalize: If True, normalize progress curves by optimality
                     gaps. Defaults to True.
   :type normalize: bool, optional
   :param all_in_one: If True, plot all curves in one figure.
                      Defaults to True.
   :type all_in_one: bool, optional
   :param plot_title: Custom title to override the default. Used only if
                      all_in_one is True.
   :type plot_title: str, optional
   :param ext: File extension for saved plots (e.g., ".png").
               Defaults to ".png".
   :type ext: str, optional
   :param save_as_pickle: If True, save the plot as a pickle file.
                          Defaults to False.
   :type save_as_pickle: bool, optional
   :param solver_set_name: Label for solver group in plot titles.
                           Defaults to "SOLVER_SET".
   :type solver_set_name: str, optional

   :returns: List of file paths for the plots produced.
   :rtype: list[str]

   :raises ValueError: If an unsupported plot type is specified.