SamplerV2
class SamplerV2(mode=None, options=None)
Bases: BasePrimitiveV2[SamplerOptions], Sampler, BaseSamplerV2
Class for interacting with Qiskit Runtime Sampler primitive service.
This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1.
Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested.
The run() method can be used to submit circuits and parameters to the Sampler primitive.
Parameters
-
mode (BackendV2 |Session |Batch | None) –
The execution mode used to make the primitive query. It can be:
- A
Backendif you are using job mode. - A
Sessionif you are using session execution mode. - A
Batchif you are using batch execution mode.
Refer to the Qiskit Runtime documentation for more information about the
Execution modes. - A
-
options (dict | SamplerOptions | None) – Sampler options, see
qiskit_ibm_runtime.options.SamplerOptionsfor detailed description.
Attributes
mode
Return the execution mode used by this primitive.
Returns
Mode used by this primitive, or None if an execution mode is not used.
options
Type: SamplerOptions
Return options.
version
Default value: 2
Methods
backend
run
run(pubs, *, shots=None)
Submit a request to the sampler primitive.
Parameters
- pubs (Iterable[SamplerPub |QuantumCircuit | tuple[QuantumCircuit] | tuple[QuantumCircuit, Mapping[Parameter | str | tuple[Parameter | str, ...], _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]]] | tuple[QuantumCircuit, Mapping[Parameter | str | tuple[Parameter | str, ...], _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]], Integral | None]]) – 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
Submitted job. The result of the job is an instance of qiskit.primitives.containers.PrimitiveResult.
Raises
ValueError – Invalid arguments are given.
Return type