Update documentation

ziatdinovmax · Mar 20, 2024 · cb28ab8 · cb28ab8
1 parent 66e9b2c
commit cb28ab8
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 28 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,9 +19,10 @@ GPax is a small Python package for physics-based Gaussian processes (GPs) built
    :caption: Package Content
 
    models
-   hypo
    acquisition
    kernels
+   priors
+   hypo
    utils
 
 .. toctree::

diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -96,3 +96,13 @@ Multi-Task Learning
     :undoc-members:
     :member-order: bysource
     :show-inheritance:
+
+Structured Probabilistic Models
+-------------------------------
+.. autoclass:: gpax.models.spm.sPM
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :member-order: bysource
+    :show-inheritance:
+
diff --git a/docs/source/priors.rst b/docs/source/priors.rst
@@ -0,0 +1,23 @@
+Priors
+======
+
+.. autofunction:: gpax.utils.normal_dist
+
+.. autofunction:: gpax.utils.lognormal_dist
+
+.. autofunction:: gpax.utils.halfnormal_dist
+
+.. autofunction:: gpax.utils.gamma_dist
+
+.. autofunction:: gpax.utils.uniform_dist
+
+.. autofunction:: gpax.utils.place_normal_prior
+
+.. autofunction:: gpax.utils.place_lognormal_prior
+
+.. autofunction:: gpax.utils.place_halfnormal_prior
+
+.. autofunction:: gpax.utils.place_uniform_prior
+
+.. autofunction:: gpax.utils.place_gamma_prior
+
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -1,40 +1,17 @@
 Utilities
 =========
 
-Priors
-------
+Automatic function setters
+--------------------------
 
-.. autofunction:: gpax.utils.normal_dist
+.. autofunction:: gpax.utils.set_fn
 
-.. autofunction:: gpax.utils.lognormal_dist
-
-.. autofunction:: gpax.utils.halfnormal_dist
-
-.. autofunction:: gpax.utils.gamma_dist
-
-.. autofunction:: gpax.utils.uniform_dist
-
-.. autofunction:: gpax.utils.place_normal_prior
-
-.. autofunction:: gpax.utils.place_lognormal_prior
-
-.. autofunction:: gpax.utils.place_halfnormal_prior
-
-.. autofunction:: gpax.utils.place_uniform_prior
-
-.. autofunction:: gpax.utils.place_gamma_prior
+.. autofunction:: gpax.utils.set_kernel_fn
 
 
 Other utilities
 ---------------
 
-.. autoclass:: gpax.models.spm.sPM
-    :members:
-    :inherited-members:
-    :undoc-members:
-    :member-order: bysource
-    :show-inheritance:
-
 .. autofunction:: gpax.utils.dviz
 
 .. autofunction:: gpax.utils.get_keys