Skip to content

Commit 681d743

Browse files
committed
Added BayesQAE doc
1 parent 1a38336 commit 681d743

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

doc/ae.bayesian_ae.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
bayesian_ae
2+
===========
3+
4+
.. automodule:: QQuantLib.AE.bayesian_ae
5+
:members:
6+

doc/ae.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The **Amplitude Estimation (AE)** package comprises modules that implement diffe
1111
* :doc:`ae.mlae_utils`: This module contains functions used for the: *QQuantLib.AE..maximum_likelihood_ae* module.
1212
* :doc:`ae.iterative_quantum_ae`: This module contains the Python class IQAE that implements the Iterative Quantum Amplitude Estimation algorithm.
1313
* :doc:`ae.miterative_quantum_ae`: This module contains the Python class mIQAE that implements a modification of the Iterative Quantum Amplitude Estimation algorithm that increases the performance over the IQAE.
14+
* :doc:`ae.bayesian_ae`: This module contains the Python class BAYESQAE that implements the Bayesian Quantum Amplitude Estimation algorithm.
1415
* :doc:`ae.real_quantum_ae`: This module contains the Python class RQAE that implements the Real Quantum Amplitude Estimation algorithm. This algorithm estimates the **amplitude** of the given target state instead of its probability.
1516
* :doc:`ae.mreal_quantum_ae`: This module contains the Python class mRQAE that implements a modification of the Real Quantum Amplitude Estimation algorithm that increases theoretical performance over the RQAE. This algorithm estimates the **amplitude** of the given target state instead of its probability.
1617
* :doc:`ae.sreal_quantum_ae`: This module contains the Python class sRQAE that implements a modification of the Real Quantum Amplitude Estimation algorithm where the user can provide the number of shots the generated quantum circuits should be measured. This algorithm estimates the **amplitude** of the given target state instead of its probability.
@@ -60,6 +61,12 @@ The **Amplitude Estimation (AE)** package comprises modules that implement diffe
6061

6162
ae.miterative_quantum_ae.rst
6263

64+
.. toctree::
65+
:maxdepth: 1
66+
:hidden:
67+
68+
ae.bayesian_ae.rst
69+
6370
.. toctree::
6471
:maxdepth: 1
6572
:hidden:

0 commit comments

Comments
 (0)