Merge qiskit-runtime into qiskit-ibm-runtime

qiskit_runtime/__init__.py

@@ -0,0 +1,19 @@
+# This code is part of qiskit-runtime.
+#
+# (C) Copyright IBM 2021.
+#
+# 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.
+
+"""Main entry point for the qiskit_runtime"""
+
+
+try:
+    from .version import version as __version__
+except ImportError:
+    __version__ = "0.0.0"

qiskit_runtime/circuit_runner/__init__.py

@@ -0,0 +1,15 @@
+# This code is part of qiskit-runtime.
+#
+# (C) Copyright IBM 2021.
+#
+# 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.
+
+"""
+Qiskit circuit runner module
+"""

qiskit_runtime/circuit_runner/circuit_runner.json

@@ -0,0 +1,23 @@
+{
+  "name": "circuit-runner",
+  "description": "A runtime program that takes one or more circuits, compiles them, executes them, and optionally applies measurement error mitigation.",
+  "max_execution_time": 14400,
+  "version": "1.0",
+  "parameters": [
+    {"name": "circuits", "description": "A circuit or a list of circuits.", "type": "A QuantumCircuit or a list of QuantumCircuits.", "required": true},
+    {"name": "shots", "description": "Number of repetitions of each circuit, for sampling. Default: 1024.", "type": "int", "required": false},
+    {"name": "initial_layout", "description": "Initial position of virtual qubits on physical qubits.", "type": "dict or list", "required": false},
+    {"name": "layout_method", "description": "Name of layout selection pass ('trivial', 'dense', 'noise_adaptive', 'sabre')", "type": "string", "required": false},
+    {"name": "routing_method", "description": "Name of routing pass ('basic', 'lookahead', 'stochastic', 'sabre').", "type": "string", "required": false},
+    {"name": "translation_method", "description": "Name of translation pass ('unroller', 'translator', 'synthesis').", "type": "string", "required": false},
+    {"name": "seed_transpiler", "description": "Sets random seed for the stochastic parts of the transpiler.", "type": "int", "required": false},
+    {"name": "optimization_level", "description": "How much optimization to perform on the circuits (0-3). Higher levels generate more optimized circuits. Default is 1.", "type": "int", "required": false},
+    {"name": "init_qubits", "description": "Whether to reset the qubits to the ground state for each shot.", "type": "bool", "required": false},
+    {"name": "rep_delay", "description": "Delay between programs in seconds.", "type": "float", "required": false},
+    {"name": "transpiler_options", "description": "Additional compilation options.", "type": "dict", "required": false},
+    {"name": "measurement_error_mitigation", "description": "Whether to apply measurement error mitigation. Default is False.", "type": "bool", "required": false}
+  ],
+  "return_values": [
+    {"name": "-", "description": "Circuit execution results.", "type": "RunnerResult object"}
+  ]
+}

qiskit_runtime/circuit_runner/circuit_runner.py

@@ -0,0 +1,68 @@
+# This code is part of qiskit-runtime.
+#
+# (C) Copyright IBM 2021.
+#
+# 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.
+
+"""Circuit-runner runtime program.
+
+This is a simplified version of the circuit-runner program.
+"""
+
+from qiskit.compiler import transpile, schedule
+
+
+def main(
+    backend,
+    user_messenger,  # pylint: disable=unused-argument
+    circuits,
+    initial_layout=None,
+    seed_transpiler=None,
+    optimization_level=None,
+    transpiler_options=None,
+    scheduling_method=None,
+    schedule_circuit=False,
+    inst_map=None,
+    meas_map=None,
+    measurement_error_mitigation=False,
+    **kwargs,
+):
+    """Run the circuits on the backend."""
+
+    # transpiling the circuits using given transpile options
+    transpiler_options = transpiler_options or {}
+    circuits = transpile(
+        circuits,
+        initial_layout=initial_layout,
+        seed_transpiler=seed_transpiler,
+        optimization_level=optimization_level,
+        backend=backend,
+        **transpiler_options,
+    )
+
+    if schedule_circuit:
+        circuits = schedule(
+            circuits=circuits,
+            backend=backend,
+            inst_map=inst_map,
+            meas_map=meas_map,
+            method=scheduling_method,
+        )
+
+    if not isinstance(circuits, list):
+        circuits = [circuits]
+
+    # Compute raw results
+    result = backend.run(circuits, **kwargs).result()
+
+    if measurement_error_mitigation:
+        # Performs measurement error mitigation.
+        pass
+
+    return result.to_dict()

qiskit_runtime/hello_world/__init__.py

@@ -0,0 +1,13 @@
+# This code is part of qiskit-runtime.
+#
+# (C) Copyright IBM 2021.
+#
+# 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.
+
+"""Package containing ``hello-world`` Qiskit quantum program."""

qiskit_runtime/hello_world/hello_world.json

@@ -0,0 +1,41 @@
+{
+  "name": "hello-world",
+  "description": "A sample runtime program.",
+  "max_execution_time": 300,
+  "spec": {
+    "backend_requirements": {
+      "min_num_qubits": 5
+    },
+    "parameters": {
+      "$schema": "https://json-schema.org/draft/2019-09/schema",
+      "properties": {
+        "iterations": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of iterations to run. Each iteration generates a runs a random circuit."
+        }
+      },
+      "required": [
+        "iterations"
+      ]
+    },
+    "return_values": {
+      "$schema": "https://json-schema.org/draft/2019-09/schema",
+      "description": "A string that says 'All done!'.",
+      "type": "string"
+    },
+    "interim_results": {
+      "$schema": "https://json-schema.org/draft/2019-09/schema",
+      "properties": {
+        "iteration": {
+          "type": "integer",
+          "description": "Iteration number."
+        },
+        "counts": {
+          "description": "Histogram data of the circuit result.",
+          "type": "object"
+        }
+      }
+    }
+  }
+}

qiskit_runtime/hello_world/hello_world.py

@@ -0,0 +1,55 @@
+# This code is part of qiskit-runtime.
+#
+# (C) Copyright IBM 2021.
+#
+# 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.
+
+"""A sample runtime program called hello-world that submits random circuits
+for user-specified iterations.
+"""
+
+import random
+from typing import Any
+
+from qiskit import transpile
+from qiskit.circuit.random import random_circuit
+
+
+def prepare_circuits(backend):
+    """Generate a random circuit.
+
+    Args:
+        backend (qiskit.providers.Backend): Backend used for transpilation.
+
+    Returns:
+        qiskit.QuantumCircuit: Generated circuit.
+    """
+    circuit = random_circuit(num_qubits=5, depth=4, measure=True, seed=random.randint(0, 1000))
+    return transpile(circuit, backend)
+
+
+def main(backend, user_messenger, **kwargs) -> Any:
+    """Main entry point of the program.
+
+    Args:
+        backend (qiskit.providers.Backend): Backend to submit the circuits to.
+        user_messenger (qiskit.providers.ibmq.runtime.UserMessenger): Used to communicate with the
+            program consumer.
+        kwargs: User inputs.
+
+    Returns:
+        Final result of the program.
+    """
+    iterations = kwargs.pop("iterations", 1)
+    for it in range(iterations):
+        qc = prepare_circuits(backend)
+        result = backend.run(qc).result()
+        user_messenger.publish({"iteration": it, "counts": result.get_counts()})
+
+    return "All done!"