pybop.plot.parameters#

Functions#

parameters(result[, title, show, backend, figures, axes])

Plot the evolution of parameters during the optimisation process using Plotly.

Module Contents#

pybop.plot.parameters.parameters(result: pybop._result.Result, title: str = 'Parameter Convergence', show: bool = True, backend: str = None, figures=None, axes=None)[source]#

Plot the evolution of parameters during the optimisation process using Plotly.

Parameters:

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

  • title (str, optional) – The title of the plot (default: “Parameter Convergence”).

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

  • backend (str or pybop.plot.backends.PlotBackend, optional) – The plotting backend to be used

  • figures (figure object , optional) – Figure for plotting. If not provided a new figure is created. Can be a single figure or one figure per parameter.

  • axes (single axis or list of axes, optional) – axes for plotting plotly: axes expected to be of the form tuple(row, col) Number of axis must either agree with the number of parameters or be a single axis for all parameters.

Returns:

  • fig (if show is False; plotly.graph_objs.Figure or matplotlib.figure.Figure) – The figure object for the parameter plot. Returns a list of figures if multiple figures are provided for plotting.

  • None (if show is True)