Skip to content

Commit cb28ab8

Browse files
committed
Update documentation
1 parent 66e9b2c commit cb28ab8

File tree

4 files changed

+39
-28
lines changed

4 files changed

+39
-28
lines changed

docs/source/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ GPax is a small Python package for physics-based Gaussian processes (GPs) built
1919
:caption: Package Content
2020

2121
models
22-
hypo
2322
acquisition
2423
kernels
24+
priors
25+
hypo
2526
utils
2627

2728
.. toctree::

docs/source/models.rst

+10
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,13 @@ Multi-Task Learning
9696
:undoc-members:
9797
:member-order: bysource
9898
:show-inheritance:
99+
100+
Structured Probabilistic Models
101+
-------------------------------
102+
.. autoclass:: gpax.models.spm.sPM
103+
:members:
104+
:inherited-members:
105+
:undoc-members:
106+
:member-order: bysource
107+
:show-inheritance:
108+

docs/source/priors.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Priors
2+
======
3+
4+
.. autofunction:: gpax.utils.normal_dist
5+
6+
.. autofunction:: gpax.utils.lognormal_dist
7+
8+
.. autofunction:: gpax.utils.halfnormal_dist
9+
10+
.. autofunction:: gpax.utils.gamma_dist
11+
12+
.. autofunction:: gpax.utils.uniform_dist
13+
14+
.. autofunction:: gpax.utils.place_normal_prior
15+
16+
.. autofunction:: gpax.utils.place_lognormal_prior
17+
18+
.. autofunction:: gpax.utils.place_halfnormal_prior
19+
20+
.. autofunction:: gpax.utils.place_uniform_prior
21+
22+
.. autofunction:: gpax.utils.place_gamma_prior
23+

docs/source/utils.rst

+4-27
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,17 @@
11
Utilities
22
=========
33

4-
Priors
5-
------
4+
Automatic function setters
5+
--------------------------
66

7-
.. autofunction:: gpax.utils.normal_dist
7+
.. autofunction:: gpax.utils.set_fn
88

9-
.. autofunction:: gpax.utils.lognormal_dist
10-
11-
.. autofunction:: gpax.utils.halfnormal_dist
12-
13-
.. autofunction:: gpax.utils.gamma_dist
14-
15-
.. autofunction:: gpax.utils.uniform_dist
16-
17-
.. autofunction:: gpax.utils.place_normal_prior
18-
19-
.. autofunction:: gpax.utils.place_lognormal_prior
20-
21-
.. autofunction:: gpax.utils.place_halfnormal_prior
22-
23-
.. autofunction:: gpax.utils.place_uniform_prior
24-
25-
.. autofunction:: gpax.utils.place_gamma_prior
9+
.. autofunction:: gpax.utils.set_kernel_fn
2610

2711

2812
Other utilities
2913
---------------
3014

31-
.. autoclass:: gpax.models.spm.sPM
32-
:members:
33-
:inherited-members:
34-
:undoc-members:
35-
:member-order: bysource
36-
:show-inheritance:
37-
3815
.. autofunction:: gpax.utils.dviz
3916

4017
.. autofunction:: gpax.utils.get_keys

0 commit comments

Comments
 (0)