moscot.backends.ott.OTTOutput.plot_costs

OTTOutput.plot_costs(last=None, title=None, return_fig=False, ax=None, figsize=None, dpi=None, save=None, **kwargs)

Plot regularized OT costs during the iterations.

Parameters:

• last (Optional[int]) – How many of the last steps of the algorithm to plot. If None, plot the full curve.

• title (Optional[str]) – Title of the plot. If None, it is determined automatically.

• return_fig (bool) – Whether to return the figure.

• ax (Optional[Axes]) – Axes on which to plot.

• figsize (Optional[Tuple[float, float]]) – Size of the figure.

• dpi (Optional[int]) – Dots per inch.

• save (Optional[str]) – Path where to save the figure.

• kwargs (Any) – Keyword arguments for matplotlib.axes.Axes.plot().

Return type:

Optional[Figure]

Returns:

: If return_fig = True, return the figure.