QuantumVolume
class QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)
Bases: qiskit.circuit.quantumcircuit.QuantumCircuit
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.
Reference Circuit:
(Source code, png, hires.png, pdf)
![../_images/qiskit-circuit-library-QuantumVolume-1.png](/_next/image?url=%2Fimages%2Fapi%2Fqiskit%2F0.40%2Fqiskit-circuit-library-QuantumVolume-1.png&w=1080&q=75)
Expanded Circuit:
(Source code, png, hires.png, pdf)
![../_images/qiskit-circuit-library-QuantumVolume-2.png](/_next/image?url=%2Fimages%2Fapi%2Fqiskit%2F0.40%2Fqiskit-circuit-library-QuantumVolume-2.png&w=1080&q=75)
References:
[1] A. Cross et al. Validating quantum computers using randomized model circuits, Phys. Rev. A 100, 032328 (2019). [arXiv:1811.12926]
Create quantum volume model circuit of size num_qubits x depth.
Parameters
- num_qubits (
int
) – number of active qubits in model circuit. - depth (
Optional
[int
]) – layers of SU(4) operations in model circuit. - seed (
Union
[Generator
,int
,None
]) – Random number generator or generator seed. - classical_permutation (
bool
) – use classical permutations at every layer, rather than quantum.
Attributes
ancillas
Returns a list of ancilla bits in the order that the registers were added.
Return type
List
[AncillaQubit
]
calibrations
Return calibration dictionary.
The custom pulse definition of a given gate is of the form {'gate_name': {(qubits, params): schedule}}
Return type
dict
clbits
data
Return the circuit data (instructions and context).
Returns
a list-like object containing the CircuitInstruction
s for each instruction.
Return type
QuantumCircuitData
extension_lib
Default value: 'include "qelib1.inc";'
global_phase
header
Default value: 'OPENQASM 2.0;'
instances
Default value: 2606
metadata
The user provided metadata associated with the circuit
The metadata for the circuit is a user provided dict
of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
Return type
dict
num_ancillas
Return the number of ancilla qubits.
Return type
int
num_clbits
Return number of classical bits.
Return type
int
num_parameters
The number of parameter objects in the circuit.
Return type
int
num_qubits
Return number of qubits.
Return type
int
op_start_times
Return a list of operation start times.
This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit.
Return type
List
[int
]
Returns
List of integers representing instruction start times. The index corresponds to the index of instruction in QuantumCircuit.data
.
Raises
AttributeError – When circuit is not scheduled.
parameters
The parameters defined in the circuit.
This attribute returns the Parameter
objects in the circuit sorted alphabetically. Note that parameters instantiated with a ParameterVector
are still sorted numerically.
Examples
The snippet below shows that insertion order of parameters does not matter.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant")
>>> circuit = QuantumCircuit(1)
>>> circuit.rx(b, 0)
>>> circuit.rz(elephant, 0)
>>> circuit.ry(a, 0)
>>> circuit.parameters # sorted alphabetically!
ParameterView([Parameter(a), Parameter(b), Parameter(elephant)])
Bear in mind that alphabetical sorting might be unituitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")]
>>> circuit = QuantumCircuit(1)
>>> circuit.u(*angles, 0)
>>> circuit.draw()
┌─────────────────────────────┐
q: ┤ U(angle_1,angle_2,angle_10) ├
└─────────────────────────────┘
>>> circuit.parameters
ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)])
To respect numerical sorting, a ParameterVector
can be used.
>>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector
>>> x = ParameterVector("x", 12)
>>> circuit = QuantumCircuit(1)
>>> for x_i in x:
... circuit.rx(x_i, 0)
>>> circuit.parameters
ParameterView([
ParameterVectorElement(x[0]), ParameterVectorElement(x[1]),
ParameterVectorElement(x[2]), ParameterVectorElement(x[3]),
..., ParameterVectorElement(x[11])
])
Return type
ParameterView
Returns
The sorted Parameter
objects in the circuit.
prefix
Default value: 'circuit'