Skip to main contentIBM Quantum Documentation

BaseSamplerV2

qiskit.primitives.BaseSamplerV2

GitHub(opens in a new tab)

Bases: ABC(opens in a new tab)

Sampler V2 base class.

A Sampler returns samples of quantum circuit outputs.

All sampler implementations must implement default value for the shots in the run() method if None is given both as a kwarg and in all of the pubs.


Methods

run

abstract run(pubs, *, shots=None)

GitHub(opens in a new tab)

Run and collect samples from each pub.

Parameters

  • pubs (Iterable[SamplerPubLike]) – An iterable of pub-like objects. For example, a list of circuits or tuples (circuit, parameter_values).
  • shots (int(opens in a new tab) | None) – The total number of shots to sample for each sampler pub that does not specify its own shots. If None, the primitive’s default shots value will be used, which can vary by implementation.

Returns

The job object of Sampler’s result.

Return type

BasePrimitiveJob[PrimitiveResult[PubResult]]

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