diff --git a/docs/source/api/gp.rst b/docs/source/api/gp.rst index d7770d3d52..cff3ebf903 100644 --- a/docs/source/api/gp.rst +++ b/docs/source/api/gp.rst @@ -9,3 +9,4 @@ Gaussian Processes gp/implementations gp/mean gp/cov + gp/util diff --git a/docs/source/api/gp/util.rst b/docs/source/api/gp/util.rst new file mode 100644 index 0000000000..7caacc17d4 --- /dev/null +++ b/docs/source/api/gp/util.rst @@ -0,0 +1,9 @@ +************ +GP Utilities +************ + +.. automodule:: pymc.gp.util +.. autosummary:: + :toctree: generated + + plot_gp_dist diff --git a/pymc/gp/util.py b/pymc/gp/util.py index da713b886b..0004723b70 100644 --- a/pymc/gp/util.py +++ b/pymc/gp/util.py @@ -178,30 +178,30 @@ def plot_gp_dist( Parameters ---------- - ax: axes + ax : axes Matplotlib axes. - samples: numpy.ndarray + samples : numpy.ndarray Array of S posterior predictive sample from a GP. Expected shape: (S, X) - x: numpy.ndarray + x : numpy.ndarray Grid of X values corresponding to the samples. Expected shape: (X,) or (X, 1), or (1, X) - plot_samples: bool + plot_samples : bool Plot the GP samples along with posterior (defaults True). - palette: str + palette : str Palette for coloring output (defaults to "Reds"). - fill_alpha: float + fill_alpha : float Alpha value for the posterior interval fill (defaults to 0.8). - samples_alpha: float + samples_alpha : float Alpha value for the sample lines (defaults to 0.1). - fill_kwargs: dict + fill_kwargs : dict Additional arguments for posterior interval fill (fill_between). - samples_kwargs: dict + samples_kwargs : dict Additional keyword arguments for samples plot. Returns ------- - ax: Matplotlib axes + ax : Matplotlib axes """ import matplotlib.pyplot as plt