129 lines
7.0 KiB
Plaintext
129 lines
7.0 KiB
Plaintext
---
|
||
title: GradientBase
|
||
description: API reference for qiskit.aqua.operators.gradients.GradientBase
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.operators.gradients.GradientBase
|
||
---
|
||
|
||
# qiskit.aqua.operators.gradients.GradientBase
|
||
|
||
<Class id="qiskit.aqua.operators.gradients.GradientBase" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/operators/gradients/gradient_base.py" signature="GradientBase(grad_method='param_shift', **kwargs)" modifiers="class">
|
||
Base class for first-order operator gradient.
|
||
|
||
Convert an operator expression to the first-order gradient.
|
||
|
||
**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.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.aqua.operators.gradients.GradientBase.__init__" signature="__init__(grad_method='param_shift', **kwargs)">
|
||
**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.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.aqua.operators.gradients.GradientBase.__init__ "qiskit.aqua.operators.gradients.GradientBase.__init__")(\[grad\_method]) | **type grad\_method**`Union`\[`str`, `CircuitGradient`] |
|
||
| [`convert`](#qiskit.aqua.operators.gradients.GradientBase.convert "qiskit.aqua.operators.gradients.GradientBase.convert")(operator\[, params]) | **type operator**`OperatorBase` |
|
||
| [`gradient_wrapper`](#qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper "qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper")(operator, bind\_params\[, …]) | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. |
|
||
| [`parameter_expression_grad`](#qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad "qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad")(param\_expr, param) | Get the derivative of a parameter expression w\.r.t. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
||
| [`grad_method`](#qiskit.aqua.operators.gradients.GradientBase.grad_method "qiskit.aqua.operators.gradients.GradientBase.grad_method") | Returns `CircuitGradient`. |
|
||
|
||
### convert
|
||
|
||
<Function id="qiskit.aqua.operators.gradients.GradientBase.convert" signature="convert(operator, params=None)" modifiers="abstract">
|
||
**Parameters**
|
||
|
||
* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of
|
||
* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to.
|
||
|
||
**Return type**
|
||
|
||
`OperatorBase`
|
||
|
||
**Returns**
|
||
|
||
An operator whose evaluation yields the gradient, Hessian or QFI.
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – If `params` contains a parameter not present in `operator`.
|
||
</Function>
|
||
|
||
### grad\_method
|
||
|
||
<Attribute id="qiskit.aqua.operators.gradients.GradientBase.grad_method">
|
||
Returns `CircuitGradient`.
|
||
|
||
**Return type**
|
||
|
||
`CircuitGradient`
|
||
|
||
**Returns**
|
||
|
||
`CircuitGradient`.
|
||
</Attribute>
|
||
|
||
### gradient\_wrapper
|
||
|
||
<Function id="qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper" signature="gradient_wrapper(operator, bind_params, grad_params=None, backend=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** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned.
|
||
* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`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** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI.
|
||
|
||
**Returns**
|
||
|
||
Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values.
|
||
|
||
**Return type**
|
||
|
||
callable(param\_values)
|
||
</Function>
|
||
|
||
### parameter\_expression\_grad
|
||
|
||
<Function id="qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad" signature="parameter_expression_grad(param_expr, param)" modifiers="static">
|
||
Get the derivative of a parameter expression w\.r.t. the given parameter.
|
||
|
||
**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
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`ParameterExpression`, `float`]
|
||
|
||
**Returns**
|
||
|
||
ParameterExpression representing the gradient of param\_expr w\.r.t. param
|
||
</Function>
|
||
</Class>
|
||
|