Implementation of the Predictor Tracer

CHANGELOG.md

@@ -14,6 +14,7 @@ This project adheres to [Semantic Versioning], with the exception that minor rel
 - ✨ Improved the MDP and extended the RL predictor's action/state space (expanded observation vector, support for stochastic passes, wrapped stochastic actions) ([#449]) ([**@Shaobo-Zhou**])
 - ✨ Added AIRouting and new optimization actions (KAKDecomposition, ElidePermutations) to the RL action set ([#449]) ([**@Shaobo-Zhou**])
 - ✨ Improve RL reward design by adding intermediate rewards ([#526]) ([**@Shaobo-Zhou**])
+- ✨ Added CompilationTracer that collects compilation information and exports it to a JSON file ([#641]) ([**@linus-hologram**])
 - 🔧 Replace `mypy` with `ty` ([#572]) ([**@denialhaag**])
 - 🐛 Fix instruction duration unit in estimated success probability calculation ([#445]) ([**@Shaobo-Zhou**])
 
@@ -65,6 +66,7 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
 [#393]: https://github.com/munich-quantum-toolkit/predictor/pull/393
 [#385]: https://github.com/munich-quantum-toolkit/predictor/pull/385
 [#360]: https://github.com/munich-quantum-toolkit/predictor/pull/360
+[#641]: https://github.com/munich-quantum-toolkit/predictor/pull/641
 
 <!-- Contributor -->
 
@@ -74,6 +76,7 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
 [**@denialhaag**]: https://github.com/denialhaag
 [**@bachase**]: https://github.com/bachase
 [**@Shaobo-Zhou**]: https://github.com/Shaobo-Zhou
+[**@linus-hologram**]: https://github.com/linus-hologram
 
 <!-- General links -->
 

src/mqt/predictor/qcompile.py

@@ -16,6 +16,8 @@
 from mqt.predictor.rl import rl_compile
 
 if TYPE_CHECKING:
+    from pathlib import Path
+
     from qiskit import QuantumCircuit
 
     from mqt.predictor.reward import figure_of_merit
@@ -24,16 +26,20 @@
 def qcompile(
     qc: QuantumCircuit,
     figure_of_merit: figure_of_merit = "expected_fidelity",
+    tracer_output_path: str | Path | None = None,
 ) -> tuple[QuantumCircuit, list[str], str]:
     """Compiles a given quantum circuit to a device with the highest predicted figure of merit.
 
     Arguments:
         qc: The quantum circuit to be compiled.
         figure_of_merit: The figure of merit to be used for compilation. Defaults to "expected_fidelity".
+        tracer_output_path: If provided, enables compiler tracing and exports the JSON log to this path/directory.
 
     Returns:
         A tuple containing the compiled quantum circuit, the compilation information, and the name of the device used for compilation.
     """
     predicted_device = predict_device_for_figure_of_merit(qc, figure_of_merit=figure_of_merit)
-    res = rl_compile(qc, device=predicted_device, figure_of_merit=figure_of_merit)
+    res = rl_compile(
+        qc, device=predicted_device, figure_of_merit=figure_of_merit, tracer_output_path=tracer_output_path
+    )
     return *res, predicted_device

src/mqt/predictor/rl/actions.py

@@ -10,16 +10,13 @@
 
 from __future__ import annotations
 
-import os
 import sys
 import warnings
 from collections import defaultdict
 from dataclasses import dataclass
 from enum import Enum
 from typing import TYPE_CHECKING
 
-from bqskit import MachineModel
-from bqskit import compile as bqskit_compile
 from pytket.architecture import Architecture
 from pytket.passes import (
     CliffordSimp,
@@ -78,7 +75,6 @@
 
 from mqt.predictor.rl.parsing import (
     PreProcessTKETRoutingAfterQiskitLayout,
-    get_bqskit_native_gates,
 )
 
 IS_WIN_PY313 = sys.platform == "win32" and sys.version_info[:2] == (3, 13)
@@ -366,7 +362,7 @@ def remove_action(name: str) -> None:
     )
 )
 
-#register_action(
+# register_action(
 #    DeviceDependentAction(
 #        "BQSKitO2",
 #        CompilationOrigin.BQSKIT,
@@ -380,7 +376,7 @@ def remove_action(name: str) -> None:
 #            num_workers=-1,
 #        ),
 #    )
-#)
+# )
 
 register_action(
     DeviceDependentAction(
@@ -526,7 +522,7 @@ def remove_action(name: str) -> None:
     )
 )
 
-#register_action(
+# register_action(
 #    DeviceDependentAction(
 #        "BQSKitMapping",
 #        CompilationOrigin.BQSKIT,
@@ -548,7 +544,7 @@ def remove_action(name: str) -> None:
 #            )
 #        ),
 #    )
-#)
+# )
 
 register_action(
     DeviceDependentAction(
@@ -561,7 +557,7 @@ def remove_action(name: str) -> None:
     )
 )
 
-#register_action(
+# register_action(
 #    DeviceDependentAction(
 #        "BQSKitSynthesis",
 #        CompilationOrigin.BQSKIT,
@@ -578,7 +574,7 @@ def remove_action(name: str) -> None:
 #            )
 #        ),
 #    )
-#)
+# )
 
 register_action(
     DeviceIndependentAction(

src/mqt/predictor/rl/predictor.py

@@ -40,6 +40,7 @@ def __init__(
         mdp: str = "paper",
         path_training_circuits: Path | None = None,
         logger_level: int = logging.INFO,
+        tracer_output_path: str | Path | None = None,
     ) -> None:
         """Initializes the Predictor object."""
         logger.setLevel(logger_level)
@@ -49,6 +50,7 @@ def __init__(
             device=device,
             mdp=mdp,
             path_training_circuits=path_training_circuits,
+            tracer_output_path=tracer_output_path,
         )
         self.device_name = device.description
         self.figure_of_merit = figure_of_merit
@@ -178,6 +180,7 @@ def rl_compile(
     device: Target | None,
     figure_of_merit: figure_of_merit | None = "expected_fidelity",
     predictor_singleton: Predictor | None = None,
+    tracer_output_path: str | Path | None = None,
 ) -> tuple[QuantumCircuit, list[str]]:
     """Compiles a given quantum circuit to a device optimizing for the given figure of merit.
 
@@ -186,6 +189,7 @@ def rl_compile(
         device: The device to compile to.
         figure_of_merit: The figure of merit to be used for compilation. Defaults to "expected_fidelity".
         predictor_singleton: A predictor object that is used for compilation to reduce compilation time when compiling multiple quantum circuits. If None, a new predictor object is created. Defaults to None.
+        tracer_output_path: If provided, enables compiler tracing and exports the JSON log to the specified path.
 
     Returns:
         A tuple containing the compiled quantum circuit and the compilation information. If compilation fails, False is returned.
@@ -200,8 +204,14 @@ def rl_compile(
         if device is None:
             msg = "device must not be None if predictor_singleton is None."
             raise ValueError(msg)
-        predictor = Predictor(figure_of_merit=figure_of_merit, device=device)
-    else:
-        predictor = predictor_singleton
-
-    return predictor.compile_as_predicted(qc)
+        predictor = Predictor(figure_of_merit=figure_of_merit, device=device, tracer_output_path=tracer_output_path)
+        return predictor.compile_as_predicted(qc)
+
+    # use singleton and restore tracer path afterward
+    predictor = predictor_singleton
+    original_tracer_output_path = predictor.env.tracer_output_path
+    predictor.env.tracer_output_path = tracer_output_path
+    try:
+        return predictor.compile_as_predicted(qc)
+    finally:
+        predictor.env.tracer_output_path = original_tracer_output_path