Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

qiskit.algorithms.gradients


Gradients

qiskit.algorithms.gradients

Estimator Gradients

BaseEstimatorGradient(estimator[, options, ...])Base class for an EstimatorGradient to compute the gradients of the expectation value.
DerivativeType(value)Types of derivative.
FiniteDiffEstimatorGradient(estimator, epsilon)Compute the gradients of the expectation values by finite difference method [1].
LinCombEstimatorGradient(estimator[, ...])Compute the gradients of the expectation values.
ParamShiftEstimatorGradient(estimator[, ...])Compute the gradients of the expectation values by the parameter shift rule [1].
SPSAEstimatorGradient(estimator, epsilon[, ...])Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) [1].
ReverseEstimatorGradient([derivative_type])Estimator gradients with the classically efficient reverse mode.

Sampler Gradients

BaseSamplerGradient(sampler[, options])Base class for a SamplerGradient to compute the gradients of the sampling probability.
FiniteDiffSamplerGradient(sampler, epsilon)Compute the gradients of the sampling probability by finite difference method [1].
LinCombSamplerGradient(sampler[, options])Compute the gradients of the sampling probability.
ParamShiftSamplerGradient(sampler[, options])Compute the gradients of the sampling probability by the parameter shift rule [1].
SPSASamplerGradient(sampler, epsilon[, ...])Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) [1].

Quantum Geometric Tensor

BaseQGT(estimator[, phase_fix, ...])Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state.
LinCombQGT(estimator[, phase_fix, ...])Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state.
QFI(qgt[, options])Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state.
ReverseQGT([phase_fix, derivative_type])QGT calculation with the classically efficient reverse mode.

Results

EstimatorGradientResult(gradients, metadata, ...)Result of EstimatorGradient.
QFIResult(qfis, metadata, options)Result of QFI.
QGTResult(qgts, derivative_type, metadata, ...)Result of QGT.
SamplerGradientResult(gradients, metadata, ...)Result of SamplerGradient.
Was this page helpful?
Report a bug or request content on GitHub.