pybop.plot.convergence#

Functions#

convergence(result[, show, backend, figures, axes])

Plot the convergence of the optimisation algorithm.

Module Contents#

pybop.plot.convergence.convergence(result: pybop._result.Result, show: bool = True, backend: str = None, figures=None, axes=None)[source]#

Plot the convergence of the optimisation algorithm.

Parameters:

  • result (pybop.Result) – Optimisation result containing the history of parameter values and associated cost.

  • show (bool, optional) – If True, the figure is shown upon creation (default: True).

  • backend (str or pybop.plot.backends.PlotBackend, optional) – Select a plotting backend. If None, the current default backend is used.

  • figures (figure object, optional) – Figure for plotting. If not provided a new figure is created

  • axes (axis, optional) – The axis to be used for plotting plotly: axis expected to be of the form tuple(row, col)

Returns:

  • fig (if show is False; plotly.graph_objs.Figure or matplotlib.figure.Figure) – The figure object for the convergence plot.

  • None (if show is True)