simopt.plots.progress_curve

Progress curve plot.

Module Contents

simopt.plots.progress_curve.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.

Parameters:

  • experiments (list[ProblemSolver]) – Problem-solver pairs for different solvers on the same problem.

  • plot_type (PlotType) – Type of plot to produce (ALL, MEAN, or QUANTILE).

  • beta (float, optional) – Quantile level to plot (0 < beta < 1). Defaults to 0.50.

  • normalize (bool, optional) – If True, normalize curves by optimality gaps. Defaults to True.

  • all_in_one (bool, optional) – If True, plot all curves in one figure. Defaults to True.

  • n_bootstraps (int, optional) – Number of bootstrap samples. Defaults to 100.

  • conf_level (float, optional) – Confidence level for CIs (0 < conf_level < 1). Defaults to 0.95.

  • plot_conf_ints (bool, optional) – If True, plot bootstrapped confidence intervals. Defaults to True.

  • print_max_hw (bool, optional) – If True, print caption with max half-width. Defaults to True.

  • plot_title (str, optional) – Custom title for the plot (used only if all_in_one=True).

  • legend_loc (str, optional) – Location of legend (e.g., “best”, “lower right”).

  • ext (str, optional) – File extension for saved plots (e.g., “.png”). Defaults to “.png”.

  • save_as_pickle (bool, optional) – If True, save plot as a pickle file. Defaults to False.

  • solver_set_name (str, optional) – Label for solver group in plot titles. Defaults to “SOLVER_SET”.

Returns:

List of file paths where the plots were saved.

Return type:

list[Path]

Raises:

ValueError – If beta, conf_level, or n_bootstraps have invalid values.