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

BaseEstimatorGradient

qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)

GitHub(opens in a new tab)

Bases: ABC(opens in a new tab)

Base class for an EstimatorGradient to compute the gradients of the expectation value.

Parameters

  • estimator (BaseEstimator) – The estimator used to compute the gradients.

  • options (Options | None) – Primitive backend runtime options used for circuit execution. The order of priority is: options in run method > gradient’s default options > primitive’s default setting. Higher priority setting overrides lower priority setting

  • derivative_type (DerivativeType) –

    The type of derivative. Can be either DerivativeType.REAL DerivativeType.IMAG, or DerivativeType.COMPLEX.

    • DerivativeType.REAL computes 2Re[ψ(ω)O(θ)dωψ(ω)]2 \mathrm{Re}[⟨ψ(ω)|O(θ)|dω ψ(ω)〉].
    • DerivativeType.IMAG computes 2Im[ψ(ω)O(θ)dωψ(ω)]2 \mathrm{Im}[⟨ψ(ω)|O(θ)|dω ψ(ω)〉].
    • DerivativeType.COMPLEX computes 2ψ(ω)O(θ)dωψ(ω)2 ⟨ψ(ω)|O(θ)|dω ψ(ω)〉.

    Defaults to DerivativeType.REAL, as this yields e.g. the commonly-used energy gradient and this type is the only supported type for function-level schemes like finite difference.


Attributes

derivative_type

Return the derivative type (real, imaginary or complex).

Returns

The derivative type.

options

Return the union of estimator options setting and gradient default options, where, if the same field is set in both, the gradient’s default options override the primitive’s default setting.

Returns

The gradient default + estimator options.


Methods

run

run(circuits, observables, parameter_values, parameters=None, **options)

Run the job of the estimator gradient on the given circuits.

Parameters

  • circuits (Sequence[QuantumCircuit]) – The list of quantum circuits to compute the gradients.
  • observables (Sequence[BaseOperator | PauliSumOp]) – The list of observables.
  • parameter_values (Sequence[Sequence[float(opens in a new tab)]]) – The list of parameter values to be bound to the circuit.
  • parameters (Sequence[Sequence[Parameter] | None] | None) – The sequence of parameters to calculate only the gradients of the specified parameters. Each sequence of parameters corresponds to a circuit in circuits. Defaults to None, which means that the gradients of all parameters in each circuit are calculated. None in the sequence means that the gradients of all parameters in the corresponding circuit are calculated.
  • options – Primitive backend runtime options used for circuit execution. The order of priority is: options in run method > gradient’s default options > primitive’s default setting. Higher priority setting overrides lower priority setting

Returns

The job object of the gradients of the expectation values. The i-th result corresponds to circuits[i] evaluated with parameters bound as parameter_values[i]. The j-th element of the i-th result corresponds to the gradient of the i-th circuit with respect to the j-th parameter.

Raises

ValueError(opens in a new tab) – Invalid arguments are given.

Return type

AlgorithmJob

update_default_options

update_default_options(**options)

Update the gradient’s default options setting.

Parameters

**options – The fields to update the default options.

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