Skip to content
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.

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

Improve the qiskit.algorithms docs: clearly show legacy vs. primitive algorithms #9382

Merged
merged 15 commits into from
Jan 23, 2023
Merged
75 changes: 45 additions & 30 deletions qiskit/algorithms/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,32 @@
MaximumLikelihoodAmplitudeEstimationResult


Eigen Solvers
-------------
Eigensolvers
------------

Algorithms to find eigenvalues of an operator. For chemistry these can be used to find excited
states of a molecule, and qiskit-nature has some algorithms that leverage chemistry specific
knowledge to do this in that application domain. These algorithms are pending deprecation.
One should instead make use of the Eigensolver classes in the section below, which leverage
Runtime primitives.
states of a molecule, and ``qiskit-nature`` has some algorithms that leverage chemistry specific
knowledge to do this in that application domain.

Primitive-based Eigensolvers
++++++++++++++++++++++++++++

These algorithms are based on the Qiskit Primitives, such as :class:`.Estimator`.
This execution paradigm replaces the use of :class:`.QuantumInstance` in the algorithms
and in future, the primitive-based Eigensolvers should be used.
Cryoris marked this conversation as resolved.
Show resolved Hide resolved

.. autosummary::
:toctree: ../stubs/

eigensolvers


Legacy Eigensolvers
+++++++++++++++++++

These algorithms are still based on the :class:`.QuantumInstance` and are pending deprecation.
One should instead make use of the Eigensolver classes in the section above, which leverage
the Qiskit Primitives.

.. autosummary::
:toctree: ../stubs/
Expand All @@ -96,17 +114,6 @@
VQD
VQDResult

Eigensolvers
------------

Algorithms to find eigenvalues of an operator. For chemistry these can be used to find excited
states of a molecule, and qiskit-nature has some algorithms that leverage chemistry specific
knowledge to do this in that application domain.

.. autosummary::
:toctree: ../stubs/

eigensolvers

Evolvers
--------
Cryoris marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -199,12 +206,30 @@
linear_solvers


Minimum Eigen Solvers
Minimum Eigensolvers
---------------------

Algorithms that can find the minimum eigenvalue of an operator.
These algorithms are pending deprecation. One should instead make use of the
Minimum Eigensolver classes in the section below, which leverage Runtime primitives.

Primitive-based Minimum Eigensolvers
++++++++++++++++++++++++++++++++++++

These algorithms are based on the Qiskit Primitives, such as :class:`.Estimator`.
This execution paradigm replaces the use of :class:`.QuantumInstance` in the algorithms
and in future, the primitive-based Minimum Eigensolvers should be used.
Cryoris marked this conversation as resolved.
Show resolved Hide resolved

.. autosummary::
:toctree: ../stubs/

minimum_eigensolvers


Legacy Minimum Eigensolvers
+++++++++++++++++++++++++++

These algorithms are still based on the :class:`.QuantumInstance` and are pending deprecation.
One should instead make use of the Eigensolver classes in the section above, which leverage
the Qiskit Primitives.

.. autosummary::
:toctree: ../stubs/
Expand All @@ -221,16 +246,6 @@
QAOA
VQE

Minimum Eigensolvers
--------------------

Algorithms that can find the minimum eigenvalue of an operator and leverage primitives.

.. autosummary::
:toctree: ../stubs/

minimum_eigensolvers


Optimizers
----------
Expand Down