Mention the new function is multithreaded in docstring

mtreinish · Oct 2, 2024 · 06b0b0f · 06b0b0f
1 parent 9d8e4fe
commit 06b0b0f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/qiskit/circuit/library/quantum_volume.py b/qiskit/circuit/library/quantum_volume.py
@@ -132,6 +132,11 @@ def quantum_volume(
     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:**
 
     .. plot::