Skip to content

Posterior parameters doc #1644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 16, 2025
Merged

Posterior parameters doc #1644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8442683
docs: add PosteriorParameters subclasses to documentation
abelaba Aug 15, 2025
cb8647f
docs: update docs template to display shorter titles
abelaba Aug 15, 2025
7c17eac
move posterior params up in api ref, add to init
janfb Aug 16, 2025
69f8922
refactor how-to-guide
janfb Aug 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{ fullname }}
{{ objname }}
{{ underline }}

.. autoclass:: {{ fullname }}
Expand Down
4 changes: 2 additions & 2 deletions docs/how_to_guide/19_posterior_parameters.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"\n",
"inference = NRE(prior=prior)\n",
"inference.append_simulations(theta, x)\n",
"inference.train()"
"inference.train();"
]
},
{
Expand All @@ -81,7 +81,7 @@
"metadata": {},
"outputs": [],
"source": [
"from sbi.inference.posteriors.posterior_parameters import MCMCPosteriorParameters\n",
"from sbi.inference.posteriors import MCMCPosteriorParameters\n",
"\n",
"params = MCMCPosteriorParameters(\n",
" method=\"slice_np_vectorized\",\n",
Expand Down
15 changes: 15 additions & 0 deletions docs/sbi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,21 @@ Posteriors
sbi.inference.EnsemblePosterior


Posterior Parameters
--------------------

.. autosummary::
:toctree: reference/_autosummary
:nosignatures:

sbi.inference.posteriors.DirectPosteriorParameters
sbi.inference.posteriors.ImportanceSamplingPosteriorParameters
sbi.inference.posteriors.MCMCPosteriorParameters
sbi.inference.posteriors.RejectionPosteriorParameters
sbi.inference.posteriors.VectorFieldPosteriorParameters
sbi.inference.posteriors.VIPosteriorParameters


Diagnostics
-----------

Expand Down
14 changes: 14 additions & 0 deletions sbi/inference/posteriors/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
from sbi.inference.posteriors.ensemble_posterior import EnsemblePosterior
from sbi.inference.posteriors.importance_posterior import ImportanceSamplingPosterior
from sbi.inference.posteriors.mcmc_posterior import MCMCPosterior
from sbi.inference.posteriors.posterior_parameters import (
DirectPosteriorParameters,
ImportanceSamplingPosteriorParameters,
MCMCPosteriorParameters,
RejectionPosteriorParameters,
VIPosteriorParameters,
VectorFieldPosteriorParameters,
)
from sbi.inference.posteriors.rejection_posterior import RejectionPosterior
from sbi.inference.posteriors.vector_field_posterior import VectorFieldPosterior
from sbi.inference.posteriors.vi_posterior import VIPosterior
Expand All @@ -17,4 +25,10 @@
"RejectionPosterior",
"VectorFieldPosterior",
"VIPosterior",
"DirectPosteriorParameters",
"ImportanceSamplingPosteriorParameters",
"MCMCPosteriorParameters",
"RejectionPosteriorParameters",
"VectorFieldPosteriorParameters",
"VIPosteriorParameters",
]