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

CircuitGradient

CircuitGradient

GitHub(opens in a new tab)

Bases: qiskit.opflow.converters.converter_base.ConverterBase

Circuit to gradient operator converter.

Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters.

This is distinct from DerivativeBase converters which take gradients of composite operators and handle things like differentiating combo_fn’s and enforcing product rules when operator coefficients are parameterized.

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


Methods Defined Here

convert

abstract CircuitGradient.convert(operator, params=None)

Parameters

  • operator (OperatorBase) – The operator we are taking the gradient of
  • params (Union[ParameterExpression, ParameterVector, List[ParameterExpression], Tuple[ParameterExpression, ParameterExpression], List[Tuple[ParameterExpression, ParameterExpression]], None]) – The parameters we are taking the gradient wrt: ω If a ParameterExpression, ParameterVector or List[ParameterExpression] is given, then the 1st order derivative of the operator is calculated. If a Tuple[ParameterExpression, ParameterExpression] or List[Tuple[ParameterExpression, ParameterExpression]] is given, then the 2nd order derivative of the operator is calculated.

Return type

OperatorBase

Returns

An operator whose evaluation yields the Gradient.

Raises

ValueError – If params contains a parameter not present in operator.

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