HSGPBase.plot_curve#

HSGPBase.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)[source]#

Plot the curve.

Parameters:
curvexr.DataArray

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

Additional kwargs to while creating the fig and axes

sample_kwargsdict, optional

Kwargs for the plot_samples() function

hdi_kwargsdict, optional

Kwargs for the plot_hdi() function

same_axesbool

If all of the plots are on the same axis

colorsIterable[str], optional

Colors for the plots

legendbool, optional

If to include a legend. Defaults to True if same_axes

sel_to_stringCallable[[Selection], str], optional

Function to convert selection to a string. Defaults to “, “.join(f”{key}={value}” for key, value in sel.items())

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

Figure and the axes