qiskit-documentation/docs/api/qiskit/0.38/qiskit.primitives.Sampler.mdx

56 lines
1.5 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Sampler
description: API reference for qiskit.primitives.Sampler
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.primitives.Sampler
---
# Sampler
<Class id="qiskit.primitives.Sampler" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/primitives/sampler.py" signature="Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit, *args, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)" modifiers="class">
Bases: [`qiskit.primitives.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base_sampler.BaseSampler")
Sampler class
**Parameters**
* **circuits** circuits to be executed
* **parameters** Parameters of each of the quantum circuits. Defaults to `[circ.parameters for circ in circuits]`.
**Raises**
**QiskitError** if some classical bits are not used for measurements.
## Methods
### close
<Function id="qiskit.primitives.Sampler.close" signature="Sampler.close()">
Close the session and free resources
</Function>
## Attributes
### circuits
<Attribute id="qiskit.primitives.Sampler.circuits">
Quantum circuits to be sampled.
**Returns**
The quantum circuits to be sampled.
</Attribute>
### parameters
<Attribute id="qiskit.primitives.Sampler.parameters">
Parameters of quantum circuits.
**Returns**
List of the parameters in each quantum circuit.
</Attribute>
</Class>