simopt.plots.progress_curve
===========================

.. py:module:: simopt.plots.progress_curve

.. autoapi-nested-parse::

   Progress curve plot.





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

.. py:function:: plot_progress_curves(experiments: list[simopt.experiment.ProblemSolver], plot_type: simopt.plot_type.PlotType, beta: float = 0.5, normalize: bool = True, all_in_one: bool = True, n_bootstraps: int = 100, conf_level: float = 0.95, plot_conf_ints: bool = True, print_max_hw: bool = 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') -> list[pathlib.Path]

   Plots individual or aggregate progress curves for solvers on a single problem.

   :param experiments: Problem-solver pairs for different solvers
                       on the same problem.
   :type experiments: list[ProblemSolver]
   :param plot_type: Type of plot to produce (ALL, MEAN, or QUANTILE).
   :type plot_type: PlotType
   :param beta: Quantile level to plot (0 < beta < 1). Defaults to 0.50.
   :type beta: float, optional
   :param normalize: If True, normalize 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 n_bootstraps: Number of bootstrap samples. Defaults to 100.
   :type n_bootstraps: int, optional
   :param conf_level: Confidence level for CIs (0 < conf_level < 1).
                      Defaults to 0.95.
   :type conf_level: float, optional
   :param plot_conf_ints: If True, plot bootstrapped confidence
                          intervals. Defaults to True.
   :type plot_conf_ints: bool, optional
   :param print_max_hw: If True, print caption with max half-width.
                        Defaults to True.
   :type print_max_hw: bool, optional
   :param plot_title: Custom title for the plot
                      (used only if `all_in_one=True`).
   :type plot_title: str, optional
   :param legend_loc: Location of legend (e.g., "best", "lower right").
   :type legend_loc: 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 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 where the plots were saved.
   :rtype: list[Path]

   :raises ValueError: If beta, conf_level, or n_bootstraps have invalid values.