qiskit-documentation/docs/api/qiskit/qiskit.circuit.library.quan...

43 lines
2.0 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: quantum_volume (latest version)
description: API reference for qiskit.circuit.library.quantum_volume in the latest version of qiskit
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.library.quantum_volume
---
<span id="quantum-volume" />
# quantum\_volume
<Class id="qiskit.circuit.library.quantum_volume" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/library/quantum_volume.py#L133-L170" signature="qiskit.circuit.library.quantum_volume(num_qubits, depth=None, seed=None)" modifiers="class">
Bases:
A quantum volume model circuit.
The model circuits are random instances of circuits used to measure the Quantum Volume metric, as introduced in \[1].
The model circuits consist of layers of Haar random elements of SU(4) applied between corresponding pairs of qubits in a random bipartition.
This function is multithreaded and will launch a thread pool with threads equal to the number of CPUs by default. You can tune the number of threads with the `RAYON_NUM_THREADS` environment variable. For example, setting `RAYON_NUM_THREADS=4` would limit the thread pool to 4 threads.
**Reference Circuit:**
![Diagram illustrating the previously described circuit.](/images/api/qiskit/qiskit-circuit-library-quantum_volume-1.avif)
**References:**
\[1] A. Cross et al. Validating quantum computers using randomized model circuits, Phys. Rev. A 100, 032328 (2019). [arXiv:1811.12926](https://arxiv.org/abs/1811.12926)
**Parameters**
* **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"))
* **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*)
* **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| np.random.Generator | None*)
**Return type**
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
</Class>