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

BaseSamplerGradient

qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)

GitHub(opens in a new tab)

Bases: ABC(opens in a new tab)

Base class for a SamplerGradient to compute the gradients of the sampling probability.

Parameters

  • sampler (BaseSampler) – The sampler 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

Attributes

options

Return the union of sampler 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 + sampler options.


Methods

run

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

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

Parameters

  • circuits (Sequence[QuantumCircuit]) – The list of quantum circuits to compute the gradients.
  • 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 sampling probability. The i-th result corresponds to circuits[i] evaluated with parameters bound as parameter_values[i]. The j-th quasi-probability distribution in the i-th result corresponds to the gradients of the sampling probability for the j-th parameter in circuits[i].

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.