Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK. Go to the latest version.

Sampler

class Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)

GitHub

Bases: qiskit.primitives.base.base_sampler.BaseSampler

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

  • circuits – circuits to be executed
  • parameters – Parameters of each of the quantum circuits. Defaults to [circ.parameters for circ in circuits].
  • options – Default options.

Raises

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


Methods

close

Sampler.close()

Close the session and free resources

run

Sampler.run(circuits, parameter_values=None, **run_options)

Run the job of the sampling of bitstrings.

Parameters

  • circuits – One of more circuit objects.
  • parameter_values – Parameters to be bound to the circuit.
  • run_options – Backend runtime options used for circuit execution.

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 – Invalid arguments are given.

set_options

Sampler.set_options(**fields)

Set options values for the estimator.

Parameters

**fields – The fields to update the options


Attributes

circuits

Quantum circuits to be sampled.

Returns

The quantum circuits to be sampled.

options

Return options values for the estimator.

Return type

Options

Returns

options

parameters

Parameters of quantum circuits.

Returns

List of the parameters in each quantum circuit.

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