From bc17a2b77296ae86c9d6f2865c2d202f63fd4c43 Mon Sep 17 00:00:00 2001 From: Will Dean Date: Fri, 25 Apr 2025 13:15:45 -0400 Subject: [PATCH 1/4] add gp.util to toc --- docs/source/api/gp/util.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/source/api/gp/util.rst diff --git a/docs/source/api/gp/util.rst b/docs/source/api/gp/util.rst new file mode 100644 index 000000000..9a1f61a82 --- /dev/null +++ b/docs/source/api/gp/util.rst @@ -0,0 +1,10 @@ +************ +GP Utilities +************ + + +.. automodule:: pymc.gp.util +.. autosummary:: + :toctree: generated + + plot_gp_dist From f9e06c767c32e29ef821265b9dda978e57f8234a Mon Sep 17 00:00:00 2001 From: Will Dean Date: Fri, 25 Apr 2025 13:16:03 -0400 Subject: [PATCH 2/4] fix spacing in numpy style docs --- pymc/gp/util.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/pymc/gp/util.py b/pymc/gp/util.py index da713b886..0004723b7 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 From 2ea4558a226c8a73e8f19515b5eec4e8c76e8b70 Mon Sep 17 00:00:00 2001 From: Will Dean Date: Fri, 25 Apr 2025 13:40:52 -0400 Subject: [PATCH 3/4] change spacing --- docs/source/api/gp/util.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/api/gp/util.rst b/docs/source/api/gp/util.rst index 9a1f61a82..7caacc17d 100644 --- a/docs/source/api/gp/util.rst +++ b/docs/source/api/gp/util.rst @@ -2,9 +2,8 @@ GP Utilities ************ - .. automodule:: pymc.gp.util .. autosummary:: :toctree: generated - plot_gp_dist + plot_gp_dist From 8589764523f463ad2783f61736477a0376430ca7 Mon Sep 17 00:00:00 2001 From: Will Dean Date: Fri, 25 Apr 2025 13:41:06 -0400 Subject: [PATCH 4/4] add to the toc --- docs/source/api/gp.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/api/gp.rst b/docs/source/api/gp.rst index d7770d3d5..cff3ebf90 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