114 lines
3.4 KiB
Plaintext
114 lines
3.4 KiB
Plaintext
---
|
||
title: Sampler
|
||
description: API reference for qiskit_aer.primitives.Sampler
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit_aer.primitives.Sampler
|
||
---
|
||
|
||
# Sampler
|
||
|
||
<Class id="qiskit_aer.primitives.Sampler" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py" signature="Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)" modifiers="class">
|
||
Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")
|
||
|
||
Aer implementation of Sampler class.
|
||
|
||
**Run Options**
|
||
|
||
* **shots** (None or int) – The number of shots. If None, it calculates the probabilities exactly. Otherwise, it samples from multinomial distributions.
|
||
* **seed** (int) – Set a fixed seed for `seed_simulator`. If shots is None, this option is ignored.
|
||
|
||
<Admonition title="Note" type="note">
|
||
Precedence of seeding is as follows:
|
||
|
||
1. `seed_simulator` in runtime (i.e. in `__call__()`)
|
||
2. `seed` in runtime (i.e. in `__call__()`)
|
||
3. `seed_simulator` of `backend_options`.
|
||
4. default.
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** – Circuits to be executed.
|
||
* **parameters** – Parameters of each of the quantum circuits. Defaults to `[circ.parameters for circ in circuits]`.
|
||
* **backend\_options** – Options passed to AerSimulator.
|
||
* **transpile\_options** – Options passed to transpile.
|
||
* **run\_options** – Options passed to run.
|
||
* **skip\_transpilation** – if True, transpilation is skipped.
|
||
|
||
## Methods
|
||
|
||
### close
|
||
|
||
<Function id="qiskit_aer.primitives.Sampler.close" signature="Sampler.close()">
|
||
Close the session and free resources
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit_aer.primitives.Sampler.run" signature="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.
|
||
</Function>
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit_aer.primitives.Sampler.set_options" signature="Sampler.set_options(**fields)">
|
||
Set options values for the estimator.
|
||
|
||
**Parameters**
|
||
|
||
**\*\*fields** – The fields to update the options
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### circuits
|
||
|
||
<Attribute id="qiskit_aer.primitives.Sampler.circuits">
|
||
Quantum circuits to be sampled.
|
||
|
||
**Returns**
|
||
|
||
The quantum circuits to be sampled.
|
||
</Attribute>
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit_aer.primitives.Sampler.options">
|
||
Return options values for the estimator.
|
||
|
||
**Return type**
|
||
|
||
[`Options`](qiskit.providers.Options "qiskit.providers.options.Options")
|
||
|
||
**Returns**
|
||
|
||
options
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit_aer.primitives.Sampler.parameters">
|
||
Parameters of quantum circuits.
|
||
|
||
**Returns**
|
||
|
||
List of the parameters in each quantum circuit.
|
||
</Attribute>
|
||
</Class>
|
||
|