ParamShiftSamplerGradient¶

class ParamShiftSamplerGradient(sampler, options=None)[source]¶

Bases: qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient

Compute the gradients of the sampling probability by the parameter shift rule [1].

Reference: [1] Schuld, M., Bergholm, V., Gogolin, C., Izaac, J., and Killoran, N. Evaluating analytic gradients on quantum hardware, DOI

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

Methods

`run`	Run the job of the sampler gradient on the given circuits.
`update_default_options`	Update the gradient's default options setting.

Attributes

SUPPORTED_GATES = ['x', 'y', 'z', 'h', 'rx', 'ry', 'rz', 'p', 'cx', 'cy', 'cz', 'ryy', 'rxx', 'rzz', 'rzx']¶

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.

Return type: Options
Returns: The gradient default + sampler options.