Skip to content
Snippets Groups Projects
Commit 00abef1b authored by Hu Zhao's avatar Hu Zhao
Browse files

docs: create documentation for inference module

parent b34c8d30
Branches
No related tags found
No related merge requests found
Active Learning
---------------
ActiveLearning Class
^^^^^^^^^^^^^^^^^^^^
The :class:`.ActiveLearning` class is imported by::
from psimpy.inference.active_learning import ActiveLearning
Methods
*******
.. autoclass:: psimpy.inference.active_learning.ActiveLearning
:members: initial_simulation, iterative_emulation, approx_ln_pxl
\ No newline at end of file
Bayes Inference
---------------
GridEstimation Class
^^^^^^^^^^^^^^^^^^^^
The :class:`.GridEstimation` class is imported by::
from psimpy.inference.bayes_inference import GridEstimation
Methods
*******
.. autoclass:: psimpy.inference.bayes_inference.GridEstimation
:members: run
MetropolisHastingsEstimation Class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The :class:`.MetropolisHastingsEstimation` class is imported by::
from psimpy.inference.bayes_inference import MetropolisHastingsEstimation
Methods
*******
.. autoclass:: psimpy.inference.bayes_inference.MetropolisHastingsEstimation
:members: run
Inference
=========
This module hosts functionality for inference methods.
Currently implemented classes are:
* :class:`.ActiveLearning`:
* :class:`.GridEstimation`:
* :class:`.MetropolisHastingsEstimation`:
.. toctree::
:maxdepth: 1
:hidden:
:caption: Inference
Active Learning <active_learning>
Bayes Inference <bayes_inference>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment