GradientBase¶

class GradientBase(grad_method='param_shift', **kwargs)[source]¶

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 no earlier than 3 months after the release date. For code migration guidelines, visit https://qisk.it/opflow_migration.

Parameters

grad_method (Union[str, 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) -- Optional parameters for a CircuitGradient

Raises

ValueError -- If method != fin_diff and epsilon is not None.

Attributes

grad_method¶

Returns CircuitGradient.

Returns: CircuitGradient.