pybop.plot.convergence#

Functions#

convergence(result[, show])

Plot the convergence of the optimisation algorithm.

Module Contents#

pybop.plot.convergence.convergence(result: pybop._result.OptimisationResult, show=True, **layout_kwargs)[source]#

Plot the convergence of the optimisation algorithm.

Parameters:

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

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

  • **layout_kwargs (optional) – Valid Plotly layout keys and their values, e.g. xaxis_title=”Time [s]” or xaxis={“title”: “Time [s]”, font={“size”:14}}

Returns:

fig – The Plotly figure object for the convergence plot.

Return type:

plotly.graph_objs.Figure