GradientBase

class qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)

Bases: DerivativeBase

Deprecated: Base class for first-order operator gradient.

Convert an operator expression to the first-order gradient.

Deprecated since version 0.24.0

The class qiskit.opflow.gradients.gradient_base.GradientBase is deprecated as of qiskit-terra 0.24.0. It will be removed in the Qiskit 1.0 release. For code migration guidelines, visit https://qisk.it/opflow_migration(opens in a new tab).

Parameters

grad_method (str(opens in a new tab) |CircuitGradient) – The method used to compute the state/probability gradient. Can be either 'param_shift' or 'lin_comb' or 'fin_diff'. Ignored for gradients w.r.t observable parameters.
kwargs (dict(opens in a new tab)) – Optional parameters for a CircuitGradient

Raises

ValueError(opens in a new tab) – If method != fin_diff and epsilon is not None.

Attributes

grad_method

Returns CircuitGradient.

Returns

CircuitGradient.

Was this page helpful?

Report a bug or request content on GitHub.