Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version


class qiskit.opflow.gradients.DerivativeBase

GitHub(opens in a new tab)

Bases: ConverterBase

Deprecated: Base class for differentiating opflow objects.

Converter for differentiating opflow objects and handling things like properly differentiating combo_fn’s and enforcing product rules when operator coefficients are parameterized.

This is distinct from CircuitGradient converters which use quantum techniques such as parameter shifts and linear combination of unitaries to compute derivatives of circuits.

CircuitGradient - uses quantum techniques to get derivatives of circuits DerivativeBase - uses classical techniques to differentiate opflow data structures

Deprecated since version 0.24.0

The class qiskit.opflow.gradients.derivative_base.DerivativeBase is deprecated as of qiskit-terra 0.24.0. It will be removed in the Qiskit 1.0 release. For code migration guidelines, visit in a new tab).



abstract convert(operator, params=None)



An operator whose evaluation yields the gradient, Hessian or QFI.


ValueError(opens in a new tab) – If params contains a parameter not present in operator.

Return type



gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)

Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers.



Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values.

Return type

Callable(opens in a new tab)[[Iterable(opens in a new tab)], ndarray(opens in a new tab)]


static parameter_expression_grad(param_expr, param)

Get the derivative of a parameter expression w.r.t. the given parameter.

Deprecated since version 0.18.0

The method qiskit.opflow.gradients.derivative_base.DerivativeBase.parameter_expression_grad() is deprecated as of qiskit-terra 0.18.0. It will be removed in the Qiskit 1.0 release. Instead, use the ParameterExpression.gradient method.



ParameterExpression representing the gradient of param_expr w.r.t. param

Return type

ParameterExpression | float(opens in a new tab)

Was this page helpful?
Report a bug or request content on GitHub.