simopt.plots.terminal_scatterplot

Terminal scatter plot.

Module Contents

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

Parameters:

• experiments (list[list[ProblemSolver]]) – Problem-solver pairs used to produce plots.

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

• plot_title (str | None, optional) – Title to override the autogenerated one (only applies if all_in_one is True).

• legend_loc (str | None, optional) – Location of the legend (e.g., “best”). Defaults to None.

• ext (str, optional) – File extension to use for output images. Defaults to “.png”.

• save_as_pickle (bool, optional) – Whether to also save the plots as .pickle files. Defaults to False.

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

• problem_set_name (str, optional) – Name for the problem group used in plot titles. Defaults to “PROBLEM_SET”.

Returns:

A list of file paths to the plots produced.

Return type:

list[Path]