DerivativeBase
class qiskit.opflow.gradients.DerivativeBase
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
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 https://qisk.it/opflow_migration(opens in a new tab).
Methods
convert
abstract convert(operator, params=None)
Parameters
- operator (OperatorBase) – The operator we are taking the gradient, Hessian or QFI of
- params (ParameterVector |ParameterExpression |List(opens in a new tab)[ParameterExpression] | None) – The parameters we are taking the gradient, Hessian or QFI with respect to.
Returns
An operator whose evaluation yields the gradient, Hessian or QFI.
Raises
ValueError(opens in a new tab) – If params contains a parameter not present in operator.
Return type
gradient_wrapper
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.
Parameters
- operator (OperatorBase) – The operator for which we want to get the gradient, Hessian or QFI.
- bind_params (ParameterExpression |ParameterVector |List(opens in a new tab)[ParameterExpression]) – The operator parameters to which the parameter values are assigned.
- grad_params (ParameterExpression |ParameterVector |List(opens in a new tab)[ParameterExpression] | Tuple(opens in a new tab)[ParameterExpression, ParameterExpression] | List(opens in a new tab)[Tuple(opens in a new tab)[ParameterExpression, ParameterExpression]] | None) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad_params = None, then grad_params = bind_params
- backend (Backend |QuantumInstance | None) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI.
- expectation (ExpectationBase | None) – The expectation converter to be used. If none is set then PauliExpectation() is used.
Returns
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)]
parameter_expression_grad
static parameter_expression_grad(param_expr, param)
Get the derivative of a parameter expression w.r.t. the given parameter.
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.
Parameters
- param_expr (ParameterExpression) – The Parameter Expression for which we compute the derivative
- param (ParameterExpression) – Parameter w.r.t. which we want to take the derivative
Returns
ParameterExpression representing the gradient of param_expr w.r.t. param
Return type