qiskit.opflow.gradients.NaturalGradient.convert¶
-
NaturalGradient.
convert
(operator, params=None)[source]¶ - Parameters
operator (
OperatorBase
) – The operator we are taking the gradient of.params (
Union
[ParameterVector
,ParameterExpression
,List
[ParameterExpression
],None
]) – The parameters we are taking the gradient with respect to. If not explicitly passed, they are inferred from the operator and sorted by name.
- Return type
OperatorBase
- Returns
An operator whose evaluation yields the NaturalGradient.
- Raises
TypeError – If
operator
does not represent an expectation value or the quantum state is notCircuitStateFn
.ValueError – If
params
contains a parameter not present inoperator
.ValueError – If
operator
is not parameterized.