Merge benchmark suite from Qiskit/qiskit-metapackage

This merge commit pulls in the history of the airspeed-velocity
benchmark suite from its original location in the metapackage.  The
commits have been filtered to only include the history of the benchmark
suite itself, and their messages rewritten to change GitHub issue and PR
references to point to the renamed metapackage.

Author: jakelishman

test/benchmarks/__init__.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=no-member,invalid-name,missing-docstring,no-name-in-module
+# pylint: disable=attribute-defined-outside-init,unsubscriptable-object
+
+from qiskit.compiler import assemble
+from qiskit.assembler import disassemble
+
+from .utils import random_circuit
+
+
+class AssemblerBenchmarks:
+    params = ([8],
+              [4096],
+              [1, 100])
+    param_names = ['n_qubits', 'depth', 'number of circuits']
+    timeout = 600
+    version = 2
+
+    def setup(self, n_qubits, depth, number_of_circuits):
+        seed = 42
+        self.circuit = random_circuit(n_qubits, depth, measure=True,
+                                      conditional=True, seed=seed)
+        self.circuits = [self.circuit] * number_of_circuits
+
+    def time_assemble_circuit(self, _, __, ___):
+        assemble(self.circuits)
+
+
+class DisassemblerBenchmarks:
+    params = ([8],
+              [4096],
+              [1, 100])
+    param_names = ['n_qubits', 'depth', 'number of circuits']
+    timeout = 600
+
+    def setup(self, n_qubits, depth, number_of_circuits):
+        seed = 424242
+        self.circuit = random_circuit(n_qubits, depth, measure=True,
+                                      conditional=True, seed=seed)
+        self.circuits = [self.circuit] * number_of_circuits
+        self.qobj = assemble(self.circuits)
+
+    def time_disassemble_circuit(self, _, __, ___):
+        disassemble(self.qobj)

test/benchmarks/assembler.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2018, 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=missing-docstring,invalid-name,no-member
+# pylint: disable=attribute-defined-outside-init
+
+import itertools
+
+from qiskit import QuantumRegister, QuantumCircuit
+from qiskit.circuit import Parameter
+
+
+def build_circuit(width, gates):
+    qr = QuantumRegister(width)
+    qc = QuantumCircuit(qr)
+
+    while len(qc) < gates:
+        for k in range(width):
+            qc.h(qr[k])
+        for k in range(width-1):
+            qc.cx(qr[k], qr[k+1])
+
+    return qc
+
+
+class CircuitConstructionBench:
+    params = ([1, 2, 5, 8, 14, 20], [8, 128, 2048, 8192, 32768, 131072])
+    param_names = ['width', 'gates']
+    timeout = 600
+
+    def setup(self, width, gates):
+        self.empty_circuit = build_circuit(width, 0)
+        self.sample_circuit = build_circuit(width, gates)
+
+    def time_circuit_construction(self, width, gates):
+        build_circuit(width, gates)
+
+    def time_circuit_extend(self, _, __):
+        self.empty_circuit.extend(self.sample_circuit)
+
+    def time_circuit_copy(self, _, __):
+        self.sample_circuit.copy()
+
+
+def build_parameterized_circuit(width, gates, param_count):
+    params = [Parameter('param-%s' % x) for x in range(param_count)]
+    param_iter = itertools.cycle(params)
+
+    qr = QuantumRegister(width)
+    qc = QuantumCircuit(qr)
+
+    while len(qc) < gates:
+        for k in range(width):
+            param = next(param_iter)
+            qc.u2(0, param, qr[k])
+        for k in range(width-1):
+            param = next(param_iter)
+            qc.crx(param, qr[k], qr[k+1])
+
+    return qc, params
+
+
+class ParameterizedCircuitConstructionBench:
+    params = ([20], [8, 128, 2048, 8192, 32768, 131072],
+              [8, 128, 2048, 8192, 32768, 131072])
+    param_names = ['width', 'gates', 'number of params']
+    timeout = 600
+
+    def setup(self, _, gates, params):
+        if params > gates:
+            raise NotImplementedError
+
+    def time_build_parameterized_circuit(self, width, gates, params):
+        build_parameterized_circuit(width, gates, params)
+
+
+class ParameterizedCircuitBindBench:
+    params = ([20], [8, 128, 2048, 8192, 32768, 131072],
+              [8, 128, 2048, 8192, 32768, 131072])
+    param_names = ['width', 'gates', 'number of params']
+    timeout = 600
+
+    def setup(self, width, gates, params):
+        if params > gates:
+            raise NotImplementedError
+        self.circuit, self.params = build_parameterized_circuit(width,
+                                                                gates,
+                                                                params)
+
+    def time_bind_params(self, _, __, ___):
+        self.circuit.bind_parameters({x: 3.14 for x in self.params})

test/benchmarks/circuit_construction.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=no-member,invalid-name,missing-docstring,no-name-in-module
+# pylint: disable=attribute-defined-outside-init,unsubscriptable-object
+
+from qiskit import converters
+from qiskit import qasm
+
+from .utils import random_circuit
+
+
+class ConverterBenchmarks:
+    params = ([1, 2, 5, 8, 14, 20, 32, 53], [8, 128, 2048, 8192])
+    param_names = ['n_qubits', 'depth']
+    timeout = 600
+
+    def setup(self, n_qubits, depth):
+        seed = 42
+        # NOTE: Remove the benchmarks larger than 20x2048 and 14x8192, this is
+        # a tradeoff for speed of benchmarking, creating circuits this size
+        # takes more time than is worth it for benchmarks that take a couple
+        # seconds
+        if n_qubits >= 20:
+            if depth >= 2048:
+                raise NotImplementedError
+        elif n_qubits == 14:
+            if depth > 2048:
+                raise NotImplementedError
+        self.qc = random_circuit(n_qubits, depth, measure=True,
+                                 conditional=True, seed=seed)
+        self.dag = converters.circuit_to_dag(self.qc)
+        self.qasm = qasm.Qasm(data=self.qc.qasm()).parse()
+
+    def time_circuit_to_dag(self, *_):
+        converters.circuit_to_dag(self.qc)
+
+    def time_circuit_to_instruction(self, *_):
+        converters.circuit_to_instruction(self.qc)
+
+    def time_dag_to_circuit(self, *_):
+        converters.dag_to_circuit(self.dag)
+
+    def time_ast_to_circuit(self, *_):
+        converters.ast_to_dag(self.qasm)

test/benchmarks/converters.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=no-member,invalid-name,missing-docstring,no-name-in-module
+# pylint: disable=attribute-defined-outside-init,unsubscriptable-object
+
+"""Module for estimating import times."""
+
+from sys import executable
+from subprocess import call
+
+
+class QiskitImport:
+    def time_qiskit_import(self):
+        call((executable, '-c', 'import qiskit'))

test/benchmarks/import.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=missing-docstring,invalid-name,no-member
+# pylint: disable=attribute-defined-outside-init
+# pylint: disable=unused-argument
+
+from qiskit import QuantumRegister, QuantumCircuit
+from qiskit.compiler import transpile
+from qiskit.quantum_info.random import random_unitary
+
+
+class IsometryTranspileBench:
+    params = ([0, 1, 2, 3], [3, 4, 5, 6])
+    param_names = ['number of input qubits', 'number of output qubits']
+
+    def setup(self, m, n):
+        q = QuantumRegister(n)
+        qc = QuantumCircuit(q)
+        if not hasattr(qc, 'iso'):
+            raise NotImplementedError
+        iso = random_unitary(2 ** n, seed=0).data[:, 0:2 ** m]
+        if len(iso.shape) == 1:
+            iso = iso.reshape((len(iso), 1))
+        qc.iso(iso, q[:m], q[m:])
+        self.circuit = qc
+
+    def track_cnot_counts_after_mapping_to_ibmq_16_melbourne(self, *unused):
+        coupling = [[1, 0], [1, 2], [2, 3], [4, 3], [4, 10], [5, 4],
+                    [5, 6], [5, 9], [6, 8], [7, 8], [9, 8], [9, 10],
+                    [11, 3], [11, 10], [11, 12], [12, 2], [13, 1], [13, 12]]
+        circuit = transpile(self.circuit, basis_gates=['u1', 'u3', 'u2', 'cx'],
+                            coupling_map=coupling, seed_transpiler=0)
+        counts = circuit.count_ops()
+        cnot_count = counts.get('cx', 0)
+        return cnot_count