BaseSamplerV2
class qiskit.primitives.BaseSamplerV2
Bases: ABC
Base class for SamplerV2 implementations.
A Sampler returns samples of quantum circuit outputs. Implementations of this BaseSamplerV2 interface must define their own run() method, which is designed to take the following inputs:
pubs: list of pubs (Primitive Unified Blocs). A sampler pub is a list or tuple
of two to three elements that define the unit of work for the sampler. These are:
- A single
QuantumCircuit, possibly parameterized.- A collection parameter value sets to bind the circuit against if it is parametric.
- Optionally, the number of shots to sample.
shots: the number of shots to sample. This specification is optional and will be overriden by
the pub-wise shots if provided.
All sampler implementations must implement default value for the shots in the run() method. This default value will be used any time shots=None is specified, which can take place in the run() kwargs or at the pub level.
Methods
run
abstract run(pubs, *, shots=None)
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 | 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