API reference
=============

The public API is re-exported from the top-level :mod:`mimirax` package. The
modules below are documented from their source docstrings.

Contracts and types
-------------------

.. automodule:: mimirax.protocols
   :members:
   :undoc-members:

.. automodule:: mimirax.types
   :members:
   :undoc-members:

Parameters
----------

.. automodule:: mimirax.parameters
   :members:
   :undoc-members:

Observables, likelihoods and priors
-----------------------------------

.. automodule:: mimirax.observables
   :members:
   :undoc-members:

.. automodule:: mimirax.observables.reference
   :members:
   :undoc-members:

.. automodule:: mimirax.observables.m2m
   :members:
   :undoc-members:

.. automodule:: mimirax.likelihoods
   :members:
   :undoc-members:

.. automodule:: mimirax.likelihoods.gaussian
   :members:
   :undoc-members:

.. automodule:: mimirax.priors
   :members:
   :undoc-members:

.. automodule:: mimirax.priors.reference
   :members:
   :undoc-members:

Inference
---------

.. automodule:: mimirax.inference
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.objective
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.optimizers
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.hmc
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.vi
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.derivative_free
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.m2m
   :members:
   :undoc-members:

.. automodule:: mimirax.inference.resampling
   :members:
   :undoc-members:

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

.. automodule:: mimirax.diagnostics.residuals
   :members:
   :undoc-members:

.. automodule:: mimirax.diagnostics.convergence
   :members:
   :undoc-members:

.. automodule:: mimirax.diagnostics.degeneracy
   :members:
   :undoc-members:

Adapters (optional extras)
--------------------------

.. automodule:: mimirax.adapters.jaccpot
   :members:
   :undoc-members:

.. automodule:: mimirax.adapters.nornax
   :members:
   :undoc-members:

.. automodule:: mimirax.adapters.odisseo
   :members:
   :undoc-members:

Test doubles
------------

.. automodule:: mimirax.testing.doubles
   :members:
   :undoc-members:

Registry
--------

.. automodule:: mimirax._registry
   :members:
   :undoc-members: