Skip to content

Commit e6f42a0

Browse files
abelabajanfb
andauthored
docs: add posterior parameters to docs and init (#1644)
* docs: add PosteriorParameters subclasses to documentation * docs: update docs template to display shorter titles * move posterior params up in api ref, add to init * refactor how-to-guide --------- Co-authored-by: Jan <jan.boelts@mailbox.org>
1 parent 0c75b9c commit e6f42a0

File tree

4 files changed

+32
-3
lines changed

4 files changed

+32
-3
lines changed

docs/_templates/autosummary/class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{ fullname }}
1+
{{ objname }}
22
{{ underline }}
33

44
.. autoclass:: {{ fullname }}

docs/how_to_guide/19_posterior_parameters.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"\n",
6464
"inference = NRE(prior=prior)\n",
6565
"inference.append_simulations(theta, x)\n",
66-
"inference.train()"
66+
"inference.train();"
6767
]
6868
},
6969
{
@@ -81,7 +81,7 @@
8181
"metadata": {},
8282
"outputs": [],
8383
"source": [
84-
"from sbi.inference.posteriors.posterior_parameters import MCMCPosteriorParameters\n",
84+
"from sbi.inference.posteriors import MCMCPosteriorParameters\n",
8585
"\n",
8686
"params = MCMCPosteriorParameters(\n",
8787
" method=\"slice_np_vectorized\",\n",

docs/sbi.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ Posteriors
9797
sbi.inference.EnsemblePosterior
9898

9999

100+
Posterior Parameters
101+
--------------------
102+
103+
.. autosummary::
104+
:toctree: reference/_autosummary
105+
:nosignatures:
106+
107+
sbi.inference.posteriors.DirectPosteriorParameters
108+
sbi.inference.posteriors.ImportanceSamplingPosteriorParameters
109+
sbi.inference.posteriors.MCMCPosteriorParameters
110+
sbi.inference.posteriors.RejectionPosteriorParameters
111+
sbi.inference.posteriors.VectorFieldPosteriorParameters
112+
sbi.inference.posteriors.VIPosteriorParameters
113+
114+
100115
Diagnostics
101116
-----------
102117

sbi/inference/posteriors/__init__.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
from sbi.inference.posteriors.ensemble_posterior import EnsemblePosterior
66
from sbi.inference.posteriors.importance_posterior import ImportanceSamplingPosterior
77
from sbi.inference.posteriors.mcmc_posterior import MCMCPosterior
8+
from sbi.inference.posteriors.posterior_parameters import (
9+
DirectPosteriorParameters,
10+
ImportanceSamplingPosteriorParameters,
11+
MCMCPosteriorParameters,
12+
RejectionPosteriorParameters,
13+
VIPosteriorParameters,
14+
VectorFieldPosteriorParameters,
15+
)
816
from sbi.inference.posteriors.rejection_posterior import RejectionPosterior
917
from sbi.inference.posteriors.vector_field_posterior import VectorFieldPosterior
1018
from sbi.inference.posteriors.vi_posterior import VIPosterior
@@ -17,4 +25,10 @@
1725
"RejectionPosterior",
1826
"VectorFieldPosterior",
1927
"VIPosterior",
28+
"DirectPosteriorParameters",
29+
"ImportanceSamplingPosteriorParameters",
30+
"MCMCPosteriorParameters",
31+
"RejectionPosteriorParameters",
32+
"VectorFieldPosteriorParameters",
33+
"VIPosteriorParameters",
2034
]

0 commit comments

Comments
 (0)