File size: 9,780 Bytes
b7d9967 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# This code is part of a Qiskit project.
#
# (C) Copyright IBM 2018, 2023.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
"""
============================================
Qiskit Algorithms (:mod:`qiskit_algorithms`)
============================================
Qiskit Algorithms is a library of quantum algorithms for quantum computing with
`Qiskit <https://qiskit.org>`_.
These algorithms can be used to carry out research and investigate how to solve
problems in different domains on simulators and near-term real quantum devices
using shallow circuits.
The library includes some algorithms, for example the :class:`.NumPyMinimumEigensolver`, which take
the same input as their quantum counterpart but solve the problem classically. This has utility in
the near-term, where problems are still tractable classically, to validate and/or act as a reference.
There are also classical :mod:`.optimizers` for use with variational algorithms such as :class:`.VQE`.
This package also provides common building blocks for algorithms, such quantum circuit
gradients (:mod:`.gradients`) and fidelities of quantum states (:mod:`.state_fidelities`).
These elements are frequently used in a variety of applications, such as variational optimization,
time evolution and quantum machine learning.
The quantum algorithms here all use
`Primitives <https://qiskit.org/documentation/apidoc/primitives.html>`__
to execute quantum circuits. This can be an
``Estimator``, which computes expectation values, or a ``Sampler`` which computes
probability distributions. Refer to the specific algorithm for more information in this regard.
.. currentmodule:: qiskit_algorithms
Algorithms
==========
The algorithms now presented are grouped by logical function, such
as minimum eigensolvers, amplitude amplifiers, time evolvers etc. Within each group, the
algorithms conform to an interface that allows them to be used interchangeably
by different applications. E.g. a Qiskit Nature application may take a minimum
eigensolver to solve a ground state problem, and require it to
conform to the :class:`.MinimumEigensolver` interface. Any algorithm that conforms to
the interface, for example :class:`.VQE`, can be used by this application.
Amplitude Amplifiers
--------------------
Algorithms based on amplitude amplification.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
AmplificationProblem
AmplitudeAmplifier
Grover
GroverResult
Amplitude Estimators
--------------------
Algorithms based on amplitude estimation.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
AmplitudeEstimator
AmplitudeEstimatorResult
AmplitudeEstimation
AmplitudeEstimationResult
EstimationProblem
FasterAmplitudeEstimation
FasterAmplitudeEstimationResult
IterativeAmplitudeEstimation
IterativeAmplitudeEstimationResult
MaximumLikelihoodAmplitudeEstimation
MaximumLikelihoodAmplitudeEstimationResult
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/
:nosignatures:
Eigensolver
EigensolverResult
NumPyEigensolver
NumPyEigensolverResult
VQD
VQDResult
Gradients
---------
Algorithms to calculate the gradient of a quantum circuit.
.. autosummary::
:toctree:
gradients
Minimum Eigensolvers
--------------------
Algorithms to find the minimum eigenvalue of an operator.
This set of these algorithms take an ``Estimator`` primitive and can
solve for a general Hamiltonian.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
MinimumEigensolver
MinimumEigensolverResult
NumPyMinimumEigensolver
NumPyMinimumEigensolverResult
VQE
VQEResult
AdaptVQE
AdaptVQEResult
This set of algorithms take a ``Sampler`` primitive and can only
solve for a diagonal Hamiltonian, such as an Ising Hamiltonian of an optimization problem.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
SamplingMinimumEigensolver
SamplingMinimumEigensolverResult
SamplingVQE
SamplingVQEResult
QAOA
Optimizers
----------
Classical optimizers designed for use by quantum variational algorithms.
.. autosummary::
:toctree:
optimizers
Phase Estimators
----------------
Algorithms that estimate the phases of eigenstates of a unitary.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
HamiltonianPhaseEstimation
HamiltonianPhaseEstimationResult
PhaseEstimationScale
PhaseEstimation
PhaseEstimationResult
IterativePhaseEstimation
State Fidelities
----------------
Algorithms that compute the fidelity of pairs of quantum states.
.. autosummary::
:toctree:
state_fidelities
Time Evolvers
-------------
Algorithms to evolve quantum states in time. Both real and imaginary time evolution is possible
with algorithms that support them. For machine learning, Quantum Imaginary Time Evolution might be
used to train Quantum Boltzmann Machine Neural Networks for example.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
RealTimeEvolver
ImaginaryTimeEvolver
TimeEvolutionResult
TimeEvolutionProblem
PVQD
PVQDResult
SciPyImaginaryEvolver
SciPyRealEvolver
TrotterQRTE
VarQITE
VarQRTE
VarQTEResult
Variational Quantum Time Evolution
++++++++++++++++++++++++++++++++++
Classes used by variational quantum time evolution algorithms -
:class:`.VarQITE` and :class:`.VarQRTE`.
.. autosummary::
:toctree:
time_evolvers.variational
Miscellaneous
=============
Various classes used by qiskit-algorithms that are part of and exposed
by the public API.
Exceptions
----------
.. autosummary::
:toctree:
:nosignatures:
AlgorithmError
Utility classes
---------------
Utility classes and function used by algorithms.
.. autosummary::
:toctree: ../stubs/
:nosignatures:
AlgorithmJob
.. autosummary::
:toctree:
utils.algorithm_globals
"""
from .algorithm_job import AlgorithmJob
from .algorithm_result import AlgorithmResult
from .variational_algorithm import VariationalAlgorithm, VariationalResult
from .amplitude_amplifiers import Grover, GroverResult, AmplificationProblem, AmplitudeAmplifier
from .amplitude_estimators import (
AmplitudeEstimator,
AmplitudeEstimatorResult,
AmplitudeEstimation,
AmplitudeEstimationResult,
FasterAmplitudeEstimation,
FasterAmplitudeEstimationResult,
IterativeAmplitudeEstimation,
IterativeAmplitudeEstimationResult,
MaximumLikelihoodAmplitudeEstimation,
MaximumLikelihoodAmplitudeEstimationResult,
EstimationProblem,
)
from .phase_estimators import (
HamiltonianPhaseEstimation,
HamiltonianPhaseEstimationResult,
PhaseEstimationScale,
PhaseEstimation,
PhaseEstimationResult,
IterativePhaseEstimation,
)
from .exceptions import AlgorithmError
from .observables_evaluator import estimate_observables
from .time_evolvers import (
ImaginaryTimeEvolver,
RealTimeEvolver,
TimeEvolutionProblem,
TimeEvolutionResult,
PVQD,
PVQDResult,
SciPyImaginaryEvolver,
SciPyRealEvolver,
TrotterQRTE,
VarQITE,
VarQRTE,
VarQTE,
VarQTEResult,
)
from .eigensolvers import (
Eigensolver,
EigensolverResult,
NumPyEigensolver,
NumPyEigensolverResult,
VQD,
VQDResult,
)
from .minimum_eigensolvers import (
AdaptVQE,
AdaptVQEResult,
MinimumEigensolver,
MinimumEigensolverResult,
NumPyMinimumEigensolver,
NumPyMinimumEigensolverResult,
QAOA,
SamplingMinimumEigensolver,
SamplingMinimumEigensolverResult,
SamplingVQE,
SamplingVQEResult,
VQE,
VQEResult,
)
from .version import __version__
__all__ = [
"__version__",
"AlgorithmJob",
"AlgorithmResult",
"VariationalAlgorithm",
"VariationalResult",
"AmplitudeAmplifier",
"AmplificationProblem",
"Grover",
"GroverResult",
"AmplitudeEstimator",
"AmplitudeEstimatorResult",
"AmplitudeEstimation",
"AmplitudeEstimationResult",
"FasterAmplitudeEstimation",
"FasterAmplitudeEstimationResult",
"IterativeAmplitudeEstimation",
"IterativeAmplitudeEstimationResult",
"MaximumLikelihoodAmplitudeEstimation",
"MaximumLikelihoodAmplitudeEstimationResult",
"EstimationProblem",
"RealTimeEvolver",
"ImaginaryTimeEvolver",
"TimeEvolutionResult",
"TimeEvolutionProblem",
"HamiltonianPhaseEstimation",
"HamiltonianPhaseEstimationResult",
"PhaseEstimationScale",
"PhaseEstimation",
"PhaseEstimationResult",
"PVQD",
"PVQDResult",
"SciPyRealEvolver",
"SciPyImaginaryEvolver",
"TrotterQRTE",
"IterativePhaseEstimation",
"AlgorithmError",
"estimate_observables",
"VarQITE",
"VarQRTE",
"VarQTE",
"VarQTEResult",
"Eigensolver",
"EigensolverResult",
"NumPyEigensolver",
"NumPyEigensolverResult",
"VQD",
"VQDResult",
"AdaptVQE",
"AdaptVQEResult",
"MinimumEigensolver",
"MinimumEigensolverResult",
"NumPyMinimumEigensolver",
"NumPyMinimumEigensolverResult",
"QAOA",
"SamplingMinimumEigensolver",
"SamplingMinimumEigensolverResult",
"SamplingVQE",
"SamplingVQEResult",
"VQE",
"VQEResult",
]
|