QInfer/python-qinfer

..
    This work is licensed under the Creative Commons Attribution-
    NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this
    license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a
    letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View,
    California, 94041, USA.
    
.. _test_models:
    
.. currentmodule:: qinfer

Testing Models
==============

Introduction
------------

.. todo::
    Move to a guide.

QInfer provides several premade models for quickly learning how to use the
library, for making demonstrations, or to test new algorithms and approaches
built on top of QInfer.

:class:`SimplePrecessionModel` - Model of a single qubit undergoing Larmor precession
-------------------------------------------------------------------------------------

.. autoclass:: SimplePrecessionModel
    :members:

:class:`UnknownT2Model` - Model of a single qubit undergoing Larmor precession with finite decoherence
------------------------------------------------------------------------------------------------------

.. autoclass:: UnknownT2Model
    :members:

:class:`NoisyCoinModel` - Classical coin flip model corrupted by a noisy process
--------------------------------------------------------------------------------

.. autoclass:: NoisyCoinModel
    :members:

:class:`NDieModel`
------------------

.. autoclass:: NDieModel
    :members:

Custom Models
-------------

Writing custom models is standard practice for QInfer users.
See :ref:`CustomModels`.

.. currentmodule:: qinfer.tests.base_test

:meth:`test_model` - Method to run suite of tests on a model instance
---------------------------------------------------------------------

.. autofunction:: test_model