File size: 3,603 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 |
# This code is part of a Qiskit project.
#
# (C) Copyright IBM 2022, 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.
"""
Gradients (:mod:`qiskit_algorithms.gradients`)
==============================================
Algorithms to calculate the gradient of a quantum circuit.
.. currentmodule:: qiskit_algorithms.gradients
Base Classes
------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
BaseEstimatorGradient
BaseQGT
BaseSamplerGradient
EstimatorGradientResult
SamplerGradientResult
QGTResult
Finite Differences
------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
FiniteDiffEstimatorGradient
FiniteDiffSamplerGradient
Linear Combination of Unitaries
-------------------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
LinCombEstimatorGradient
LinCombSamplerGradient
LinCombQGT
Parameter Shift Rules
---------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
ParamShiftEstimatorGradient
ParamShiftSamplerGradient
Quantum Fisher Information
--------------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
QFIResult
QFI
Classical Methods
-----------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
ReverseEstimatorGradient
ReverseQGT
Simultaneous Perturbation Stochastic Approximation
--------------------------------------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
SPSAEstimatorGradient
SPSASamplerGradient
"""
from .base.base_estimator_gradient import BaseEstimatorGradient
from .base.base_qgt import BaseQGT
from .base.base_sampler_gradient import BaseSamplerGradient
from .base.estimator_gradient_result import EstimatorGradientResult
from .finite_diff.finite_diff_estimator_gradient import FiniteDiffEstimatorGradient
from .finite_diff.finite_diff_sampler_gradient import FiniteDiffSamplerGradient
from .lin_comb.lin_comb_estimator_gradient import DerivativeType, LinCombEstimatorGradient
from .lin_comb.lin_comb_qgt import LinCombQGT
from .lin_comb.lin_comb_sampler_gradient import LinCombSamplerGradient
from .param_shift.param_shift_estimator_gradient import ParamShiftEstimatorGradient
from .param_shift.param_shift_sampler_gradient import ParamShiftSamplerGradient
from .qfi import QFI
from .qfi_result import QFIResult
from .base.qgt_result import QGTResult
from .base.sampler_gradient_result import SamplerGradientResult
from .spsa.spsa_estimator_gradient import SPSAEstimatorGradient
from .spsa.spsa_sampler_gradient import SPSASamplerGradient
from .reverse.reverse_gradient import ReverseEstimatorGradient
from .reverse.reverse_qgt import ReverseQGT
__all__ = [
"BaseEstimatorGradient",
"BaseQGT",
"BaseSamplerGradient",
"DerivativeType",
"EstimatorGradientResult",
"FiniteDiffEstimatorGradient",
"FiniteDiffSamplerGradient",
"LinCombEstimatorGradient",
"LinCombQGT",
"LinCombSamplerGradient",
"ParamShiftEstimatorGradient",
"ParamShiftSamplerGradient",
"QFI",
"QFIResult",
"QGTResult",
"SamplerGradientResult",
"SPSAEstimatorGradient",
"SPSASamplerGradient",
"ReverseEstimatorGradient",
"ReverseQGT",
]
|