44 lines
2.0 KiB
Plaintext
44 lines
2.0 KiB
Plaintext
---
|
||
title: GradientBase
|
||
description: API reference for qiskit.opflow.gradients.GradientBase
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.opflow.gradients.GradientBase
|
||
---
|
||
|
||
# GradientBase
|
||
|
||
<Class id="qiskit.opflow.gradients.GradientBase" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/opflow/gradients/gradient_base.py" signature="qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)" modifiers="class">
|
||
Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase")
|
||
|
||
Deprecated: Base class for first-order operator gradient.
|
||
|
||
Convert an operator expression to the first-order gradient.
|
||
|
||
<Admonition title="Deprecated since version 0.24.0" type="danger">
|
||
The class `qiskit.opflow.gradients.gradient_base.GradientBase` is deprecated as of qiskit-terra 0.24.0. It will be removed no earlier than 3 months after the release date. For code migration guidelines, visit [https://qisk.it/opflow\_migration](https://qisk.it/opflow_migration).
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **grad\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*CircuitGradient*](qiskit.opflow.gradients.CircuitGradient "qiskit.opflow.gradients.circuit_gradients.circuit_gradient.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*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – Optional parameters for a CircuitGradient
|
||
|
||
**Raises**
|
||
|
||
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If method != `fin_diff` and `epsilon` is not None.
|
||
|
||
## Attributes
|
||
|
||
### grad\_method
|
||
|
||
<Attribute id="qiskit.opflow.gradients.GradientBase.grad_method">
|
||
Returns `CircuitGradient`.
|
||
|
||
**Returns**
|
||
|
||
`CircuitGradient`.
|
||
</Attribute>
|
||
</Class>
|
||
|