Skip to main contentIBM Quantum Documentation

Sampler

qiskit.primitives.Sampler(*, options=None) GitHub(opens in a new tab)

Bases: BaseSamplerV1[PrimitiveJob[SamplerResult]]

Sampler class.

Sampler is a reference implementation of BaseSampler.

Run Options

  • shots (None or int) – The number of shots. If None, it calculates the probabilities. Otherwise, it samples from multinomial distributions.
  • seed (np.random.Generator or int) – Set a fixed seed or generator for the multinomial distribution. If shots is None, this option is ignored.

Parameters

options (dict(opens in a new tab) | None) – Default options.

Raises

QiskitError – if some classical bits are not used for measurements.


Attributes

options

Return options values for the estimator.

Returns

options


Methods

run

run(circuits, parameter_values=None, **run_options) GitHub(opens in a new tab)

Run the job of the sampling of bitstrings.

Parameters

Returns

The job object of the result of the sampler. The i-th result corresponds to circuits[i] evaluated with parameters bound as parameter_values[i].

Raises

ValueError(opens in a new tab) – Invalid arguments are given.

Return type

T

set_options

set_options(**fields) GitHub(opens in a new tab)

Set options values for the estimator.

Parameters

**fields – The fields to update the options

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