Skip to content

Commit bd28ee9

Browse files
authored
Add gp util module to docs (#7763)
1 parent 1490141 commit bd28ee9

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

docs/source/api/gp.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ Gaussian Processes
99
gp/implementations
1010
gp/mean
1111
gp/cov
12+
gp/util

docs/source/api/gp/util.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
************
2+
GP Utilities
3+
************
4+
5+
.. automodule:: pymc.gp.util
6+
.. autosummary::
7+
:toctree: generated
8+
9+
plot_gp_dist

pymc/gp/util.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -178,30 +178,30 @@ def plot_gp_dist(
178178
179179
Parameters
180180
----------
181-
ax: axes
181+
ax : axes
182182
Matplotlib axes.
183-
samples: numpy.ndarray
183+
samples : numpy.ndarray
184184
Array of S posterior predictive sample from a GP.
185185
Expected shape: (S, X)
186-
x: numpy.ndarray
186+
x : numpy.ndarray
187187
Grid of X values corresponding to the samples.
188188
Expected shape: (X,) or (X, 1), or (1, X)
189-
plot_samples: bool
189+
plot_samples : bool
190190
Plot the GP samples along with posterior (defaults True).
191-
palette: str
191+
palette : str
192192
Palette for coloring output (defaults to "Reds").
193-
fill_alpha: float
193+
fill_alpha : float
194194
Alpha value for the posterior interval fill (defaults to 0.8).
195-
samples_alpha: float
195+
samples_alpha : float
196196
Alpha value for the sample lines (defaults to 0.1).
197-
fill_kwargs: dict
197+
fill_kwargs : dict
198198
Additional arguments for posterior interval fill (fill_between).
199-
samples_kwargs: dict
199+
samples_kwargs : dict
200200
Additional keyword arguments for samples plot.
201201
202202
Returns
203203
-------
204-
ax: Matplotlib axes
204+
ax : Matplotlib axes
205205
"""
206206
import matplotlib.pyplot as plt
207207

0 commit comments

Comments
 (0)