Skip to content

Commit

Permalink
♻️ BackendV2 migration of MQT DDSIM Qiskit backends (#267)
Browse files Browse the repository at this point in the history 
Migrating all MQT simulators from BackendV1 to BackendV2.
Besides different access patterns I also eliminated some intermediate
steps that involved dealing with QasmQobj and QasmQobjExperiment
classes, since those are deprecated. Now we will be dealing with
QuantumCircuit objects only.

---------

Signed-off-by: burgholzer <[email protected]>
Co-authored-by: burgholzer <[email protected]>
Co-authored-by: Stefan Hillmich <[email protected]>
  • Loading branch information
@andresbar98 @burgholzer @hillmich
3 people authored Sep 6, 2023
1 parent cd2b8e1 commit 0e27408
Show file tree
Hide file tree
Showing 24 changed files with 951 additions and 1,152 deletions.
12 changes: 6 additions & 6 deletions docs/source/Usage.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"\n",
"# get the QasmSimulator and sample 100000 times\n",
"backend = provider.get_backend(\"qasm_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ, backend, shots=100000)\n",
"result = job.result()\n",
"counts = result.get_counts(circ)\n",
Expand All @@ -93,7 +93,7 @@
"source": [
"# get the StatevectorSimulator and calculate the statevector\n",
"backend = provider.get_backend(\"statevector_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ, backend)\n",
"result = job.result()\n",
"statevector = result.get_statevector(circ)\n",
Expand Down Expand Up @@ -128,7 +128,7 @@
"source": [
"# get the HybridQasmSimulator and sample 100000 times using the amplitude mode and 4 threads\n",
"backend = provider.get_backend(\"hybrid_qasm_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ, backend, shots=100000, mode=\"amplitude\", nthreads=4)\n",
"result = job.result()\n",
"counts = result.get_counts(circ)\n",
Expand All @@ -155,7 +155,7 @@
"source": [
"# get the HybridStatevectorSimulator and calculate the statevector using the amplitude mode and 4 threads\n",
"backend = provider.get_backend(\"hybrid_statevector_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ, backend, mode=\"amplitude\", nthreads=4)\n",
"result = job.result()\n",
"statevector = result.get_statevector(circ)\n",
Expand All @@ -178,7 +178,7 @@
"outputs": [],
"source": [
"backend = provider.get_backend(\"path_sim_qasm_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ, backend, shots=100000) # uses the sequential strategy b\n",
"result = job.result()\n",
"counts = result.get_counts(circ)\n",
Expand Down Expand Up @@ -209,7 +209,7 @@
"source": [
"# get the UnitarySimulator and calculate the unitary functionality using the recursive mode\n",
"backend = provider.get_backend(\"unitary_simulator\")\n",
"print(f\"Backend version: {backend.configuration().backend_version}\")\n",
"print(f\"Backend version: {backend.backend_version}\")\n",
"job = execute(circ.remove_final_measurements(inplace=False), backend, mode=\"recursive\")\n",
"result = job.result()\n",
"unitary = result.get_unitary(circ)\n",
Expand Down
12 changes: 0 additions & 12 deletions src/mqt/ddsim/error.py
View file

This file was deleted.

33 changes: 33 additions & 0 deletions src/mqt/ddsim/header.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
"""Utilities for constructing a Qiskit experiment header for DDSIM backends."""
from __future__ import annotations

from dataclasses import dataclass
from typing import TYPE_CHECKING

from qiskit.result.models import QobjExperimentHeader

if TYPE_CHECKING:
from qiskit import QuantumCircuit


@dataclass
class DDSIMHeader(QobjExperimentHeader):
name: str
n_qubits: int
memory_slots: int
global_phase: float
creg_sizes: list[tuple[str, int]]
clbit_labels: list[tuple[str, int]]
qreg_sizes: list[tuple[str, int]]
qubit_labels: list[tuple[str, int]]

def __init__(self, qc: QuantumCircuit):
super().__init__()
self.name = qc.name
self.n_qubits = qc.num_qubits
self.memory_slots = qc.num_clbits
self.global_phase = qc.global_phase
self.creg_sizes = [(creg.name, creg.size) for creg in qc.cregs]
self.clbit_labels = [(creg.name, j) for creg in qc.cregs for j in range(creg.size)]
self.qreg_sizes = [(qreg.name, qreg.size) for qreg in qc.qregs]
self.qubit_labels = [(qreg.name, j) for qreg in qc.qregs for j in range(qreg.size)]
221 changes: 63 additions & 158 deletions src/mqt/ddsim/hybridqasmsimulator.py
View file
Original file line number Diff line number Diff line change
@@ -1,32 +1,41 @@
"""Backend for DDSIM Hybrid Schrodinger-Feynman Simulator."""
from __future__ import annotations

import logging
import time
import uuid
import warnings
from math import log2

from qiskit import QiskitError, QuantumCircuit
from qiskit.compiler import assemble
from qiskit.providers import BackendV1, Options
from qiskit.providers.models import BackendConfiguration, BackendStatus
from qiskit.qobj import PulseQobj, QasmQobj, QasmQobjExperiment, Qobj
from qiskit.result import Result
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from qiskit import QuantumCircuit

from qiskit import QiskitError
from qiskit.providers import Options
from qiskit.result.models import ExperimentResult, ExperimentResultData
from qiskit.transpiler import Target
from qiskit.utils.multiprocessing import local_hardware_info

from . import __version__
from .error import DDSIMError
from .job import DDSIMJob
from .header import DDSIMHeader
from .pyddsim import HybridCircuitSimulator, HybridMode

logger = logging.getLogger(__name__)
from .qasmsimulator import QasmSimulatorBackend
from .target import DDSIMTargetBuilder


class HybridQasmSimulatorBackend(BackendV1):
class HybridQasmSimulatorBackend(QasmSimulatorBackend):
"""Python interface to MQT DDSIM Hybrid Schrodinger-Feynman Simulator."""

SHOW_STATE_VECTOR = False
_HSF_TARGET = Target(description="MQT DDSIM HSF Simulator Target", num_qubits=128)

@staticmethod
def _add_operations_to_target(target: Target) -> None:
DDSIMTargetBuilder.add_0q_gates(target)
DDSIMTargetBuilder.add_1q_gates(target)
DDSIMTargetBuilder.add_2q_controlled_gates(target)
DDSIMTargetBuilder.add_barrier(target)
DDSIMTargetBuilder.add_measure(target)

def __init__(
self, name="hybrid_qasm_simulator", description="MQT DDSIM Hybrid Schrodinger-Feynman simulator"
) -> None:
super().__init__(name=name, description=description)

@classmethod
def _default_options(cls) -> Options:
Expand All @@ -38,166 +47,62 @@ def _default_options(cls) -> Options:
nthreads=local_hardware_info()["cpus"],
)

def __init__(self, configuration=None, provider=None) -> None:
conf = {
"backend_name": "hybrid_qasm_simulator",
"backend_version": __version__,
"url": "https://github.com/cda-tum/mqt-ddsim",
"simulator": True,
"local": True,
"description": "MQT DDSIM Hybrid Schrodinger-Feynman C++ simulator",
"basis_gates": [
"gphase",
"id",
"u0",
"u1",
"u2",
"u3",
"cu3",
"x",
"cx",
"y",
"cy",
"z",
"cz",
"h",
"ch",
"s",
"sdg",
"t",
"tdg",
"rx",
"crx",
"ry",
"cry",
"rz",
"crz",
"p",
"cp",
"cu1",
"sx",
"csx",
"sxdg",
# 'swap', 'cswap', 'iswap',
"snapshot",
],
"memory": False,
"n_qubits": 128,
"coupling_map": None,
"conditional": False,
"max_shots": 1000000000,
"open_pulse": False,
"gates": [],
}
super().__init__(configuration=configuration or BackendConfiguration.from_dict(conf), provider=provider)

def run(self, quantum_circuits: QuantumCircuit | list[QuantumCircuit], **options):
if isinstance(quantum_circuits, (QasmQobj, PulseQobj)):
msg = "QasmQobj and PulseQobj are not supported."
raise QiskitError(msg)
@property
def target(self):
return self._HSF_TARGET

if not isinstance(quantum_circuits, list):
quantum_circuits = [quantum_circuits]

out_options = {}
for key in options:
if not hasattr(self.options, key):
warnings.warn("Option %s is not used by this backend" % key, UserWarning, stacklevel=2)
else:
out_options[key] = options[key]
circuit_qobj = assemble(quantum_circuits, self, **out_options)

job_id = str(uuid.uuid4())
local_job = DDSIMJob(self, job_id, self._run_job, circuit_qobj, **options)
local_job.submit()
return local_job

def _run_job(self, job_id, qobj_instance: Qobj, **options):
self._validate(qobj_instance)

start = time.time()
result_list = [self.run_experiment(qobj_exp, **options) for qobj_exp in qobj_instance.experiments]
end = time.time()

result = {
"backend_name": self.configuration().backend_name,
"backend_version": self.configuration().backend_version,
"qobj_id": qobj_instance.qobj_id,
"job_id": job_id,
"results": result_list,
"status": "COMPLETED",
"success": True,
"time_taken": (end - start),
"header": qobj_instance.header.to_dict(),
}
return Result.from_dict(result)

def run_experiment(self, qobj_experiment: QasmQobjExperiment, **options):
def _run_experiment(self, qc: QuantumCircuit, **options) -> ExperimentResult:
start_time = time.time()
seed = options.get("seed", -1)
mode = options.get("mode", "amplitude")
nthreads = int(options.get("nthreads", local_hardware_info()["cpus"]))
if mode == "amplitude":
hybrid_mode = HybridMode.amplitude
max_qubits = int(log2(local_hardware_info()["memory"] * (1024**3) / 16))
algorithm_qubits = qobj_experiment.header.n_qubits
max_qubits = self.max_qubits()
algorithm_qubits = qc.num_qubits
if algorithm_qubits > max_qubits:
msg = "Not enough memory available to simulate the circuit even on a single thread"
raise DDSIMError(msg)
raise QiskitError(msg)
qubit_diff = max_qubits - algorithm_qubits
nthreads = int(min(2**qubit_diff, nthreads))
elif mode == "dd":
hybrid_mode = HybridMode.DD
else:
msg = f"Simulation mode{mode} not supported by hybrid simulator. Available modes are 'amplitude' and 'dd'."
raise DDSIMError(msg)
raise QiskitError(msg)

sim = HybridCircuitSimulator(qobj_experiment, seed=seed, mode=hybrid_mode, nthreads=nthreads)
sim = HybridCircuitSimulator(qc, seed=seed, mode=hybrid_mode, nthreads=nthreads)

shots = options.get("shots", 1024)
if self.SHOW_STATE_VECTOR and shots > 0:
logger.info(
"Statevector can only be shown if shots == 0 when using the amplitude hybrid simulation mode. Setting shots=0."
)
if self._SHOW_STATE_VECTOR and shots > 0:
print("Statevector can only be shown if shots == 0 when using the amplitude hybrid simulation mode.")
shots = 0

counts = sim.simulate(shots)
end_time = time.time()
counts_hex = {hex(int(result, 2)): count for result, count in counts.items()}

result = {
"header": qobj_experiment.header.to_dict(),
"name": qobj_experiment.header.name,
"status": "DONE",
"time_taken": end_time - start_time,
"seed": seed,
"mode": mode,
"nthreads": nthreads,
"shots": shots,
"data": {"counts": counts_hex},
"success": True,
}
if self.SHOW_STATE_VECTOR:
if sim.get_mode() == HybridMode.DD:
result["data"]["statevector"] = sim.get_vector()
else:
result["data"]["statevector"] = sim.get_final_amplitudes()

return result

def _validate(self, _quantum_circuit):
return

def status(self):
"""Return backend status.
Returns:
BackendStatus: the status of the backend.
"""
return BackendStatus(
backend_name=self.name(),
backend_version=self.configuration().backend_version,
operational=True,
pending_jobs=0,
status_msg="",

data = ExperimentResultData(
counts={hex(int(result, 2)): count for result, count in counts.items()},
statevector=None
if not self._SHOW_STATE_VECTOR
else sim.get_vector()
if sim.get_mode() == HybridMode.DD
else sim.get_final_amplitudes(),
time_taken=end_time - start_time,
mode=mode,
nthreads=nthreads,
)

metadata = qc.metadata
if metadata is None:
metadata = {}

return ExperimentResult(
shots=shots,
success=True,
status="DONE",
seed=seed,
data=data,
metadata=metadata,
header=DDSIMHeader(qc),
)
Loading

0 comments on commit 0e27408

Please sign in to comment.