TanhSaturation.plot_curve

TanhSaturation.plot_curve(curve, n_samples=10, hdi_probs=None, random_seed=None, subplot_kwargs=None, sample_kwargs=None, hdi_kwargs=None, axes=None, same_axes=False, colors=None, legend=None, sel_to_string=None)

Plot curve HDI and samples.

Parameters:

curvexr.DataArray

The curve to plot.

n_samplesint, optional

Number of samples

hdi_probsfloat | list[float], optional

HDI probabilities. Defaults to None which uses arviz default for stats.ci_prob which is 94%

random_seedint | random number generator, optional

Random number generator. Defaults to None

subplot_kwargsdict, optional

Keyword arguments for plt.subplots

sample_kwargsdict, optional

Keyword arguments for the plot_curve_sample function. Defaults to None.

hdi_kwargsdict, optional

Keyword arguments for the plot_curve_hdi function. Defaults to None.

axesnpt.NDArray[plt.Axes], optional

The exact axes to plot on. Overrides any subplot_kwargs

same_axesbool, optional

If the axes should be the same for all plots. Defaults to False.

colorsIterable[str], optional

The colors to use for the plot. Defaults to None.

legendbool, optional

If the legend should be shown. Defaults to None.

sel_to_stringSelToString, optional

The function to convert the selection to a string. Defaults to None.

Returns:

tuple[plt.Figure, npt.NDArray[plt.Axes]]