QRE Update

.github/CODEOWNERS

@@ -10,7 +10,7 @@
 /source/compiler/qsc_partial_eval @idavis @swernli
 /source/compiler/qsc_rca @idavis @swernli
 /source/compiler/qsc_rir @idavis @swernli
-/source/fuzz  @billti @idavis @swernli
+/source/fuzz @billti @idavis @swernli
 /katas @billti @swernli
 /source/jupyterlab @billti @idavis @minestarks
 /source/language_service @billti @idavis @minestarks @ScottCarda-MS
@@ -19,7 +19,9 @@
 /library @swernli @orpuente-MS
 /source/npm @billti @minestarks @ScottCarda-MS
 /source/pip @billti @idavis @minestarks
+/source/pip/qsharp/qre @msoeken @brad-lackey @jwhogabo
 /source/playground @billti @minestarks
+/source/qre @msoeken @brad-lackey @jwhogabo
 /source/resource_estimator @billti @swernli
 /samples @minestarks @swernli
 /source/vscode @billti @idavis @minestarks

Cargo.toml

@@ -27,6 +27,7 @@ members = [
     "source/language_service",
     "source/simulators",
     "source/pip",
+    "source/qre",
     "source/resource_estimator",
     "source/samples_test",
     "source/wasm",

source/pip/Cargo.toml

@@ -18,6 +18,7 @@ num-traits = { workspace = true }
 qsc = { path = "../compiler/qsc" }
 qdk_simulators = { path = "../simulators" }
 resource_estimator = { path = "../resource_estimator" }
+qre = { path = "../qre" }
 miette = { workspace = true, features = ["fancy"] }
 rustc-hash = { workspace = true }
 serde = { workspace = true, features = ["derive"] }

source/pip/benchmarks/bench_qre.py

@@ -0,0 +1,106 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+import timeit
+from dataclasses import dataclass, KW_ONLY, field
+from qsharp.qre import linear_function, generic_function
+from qsharp.qre._architecture import _make_instruction
+from qsharp.qre.models import GateBased, SurfaceCode
+from qsharp.qre._enumeration import _enumerate_instances
+
+
+def bench_enumerate_instances():
+    # Measure performance of enumerating instances with a large domain
+    @dataclass
+    class LargeDomain:
+        _: KW_ONLY
+        param1: int = field(default=0, metadata={"domain": range(1000)})
+        param2: bool
+
+    number = 100
+
+    duration = timeit.timeit(
+        "list(_enumerate_instances(LargeDomain))",
+        globals={
+            "_enumerate_instances": _enumerate_instances,
+            "LargeDomain": LargeDomain,
+        },
+        number=number,
+    )
+
+    print(f"Enumerating instances took {duration / number:.6f} seconds on average.")
+
+
+def bench_enumerate_isas():
+    import os
+    import sys
+
+    # Add the tests directory to sys.path to import test_qre
+    # TODO: Remove this once the models in test_qre are moved to a proper module
+    sys.path.append(os.path.join(os.path.dirname(__file__), "../tests/qre/"))
+    from conftest import ExampleLogicalFactory, ExampleFactory  # type: ignore
+
+    ctx = GateBased(gate_time=50, measurement_time=100).context()
+
+    # Hierarchical factory using from_components
+    query = SurfaceCode.q() * ExampleLogicalFactory.q(
+        source=SurfaceCode.q() * ExampleFactory.q()
+    )
+
+    number = 100
+    duration = timeit.timeit(
+        "list(query.enumerate(ctx))",
+        globals={
+            "query": query,
+            "ctx": ctx,
+        },
+        number=number,
+    )
+
+    print(f"Enumerating ISAs took {duration / number:.6f} seconds on average.")
+
+
+def bench_function_evaluation_linear():
+    fl = linear_function(12)
+
+    inst = _make_instruction(42, 0, None, 1, fl, None, 1.0, {})
+    number = 1000
+    duration = timeit.timeit(
+        "inst.space(5)",
+        globals={
+            "inst": inst,
+        },
+        number=number,
+    )
+
+    print(
+        f"Evaluating linear function took {duration / number:.6f} seconds on average."
+    )
+
+
+def bench_function_evaluation_generic():
+    def func(arity: int) -> int:
+        return 12 * arity
+
+    fg = generic_function(func)
+
+    inst = _make_instruction(42, 0, None, 1, fg, None, 1.0, {})
+    number = 1000
+    duration = timeit.timeit(
+        "inst.space(5)",
+        globals={
+            "inst": inst,
+        },
+        number=number,
+    )
+
+    print(
+        f"Evaluating linear function took {duration / number:.6f} seconds on average."
+    )
+
+
+if __name__ == "__main__":
+    bench_enumerate_instances()
+    bench_enumerate_isas()
+    bench_function_evaluation_linear()
+    bench_function_evaluation_generic()

source/pip/qsharp/qre/__init__.py

@@ -0,0 +1,86 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+from ._application import Application
+from ._architecture import Architecture, ISAContext
+from ._estimation import estimate
+from ._instruction import (
+    LOGICAL,
+    PHYSICAL,
+    Encoding,
+    ISATransform,
+    constraint,
+    InstructionSource,
+)
+from ._isa_enumeration import ISAQuery, ISARefNode, ISA_ROOT
+from ._qre import (
+    ISA,
+    InstructionFrontier,
+    Constraint,
+    ConstraintBound,
+    EstimationResult,
+    FactoryResult,
+    ISARequirements,
+    Block,
+    Trace,
+    block_linear_function,
+    constant_function,
+    generic_function,
+    linear_function,
+    instruction_name,
+    property_name,
+    property_name_to_key,
+)
+from ._results import (
+    EstimationTable,
+    EstimationTableColumn,
+    EstimationTableEntry,
+    plot_estimates,
+)
+from ._trace import LatticeSurgery, PSSPC, TraceQuery, TraceTransform
+
+# Extend Rust Python types with additional Python-side functionality
+from ._instruction import _isa_as_frame, _requirements_as_frame
+
+ISA.as_frame = _isa_as_frame
+ISARequirements.as_frame = _requirements_as_frame
+
+__all__ = [
+    "block_linear_function",
+    "constant_function",
+    "constraint",
+    "estimate",
+    "linear_function",
+    "plot_estimates",
+    "Application",
+    "Architecture",
+    "Block",
+    "Constraint",
+    "ConstraintBound",
+    "Encoding",
+    "EstimationResult",
+    "EstimationTable",
+    "EstimationTableColumn",
+    "EstimationTableEntry",
+    "FactoryResult",
+    "generic_function",
+    "instruction_name",
+    "InstructionFrontier",
+    "InstructionSource",
+    "ISA",
+    "ISA_ROOT",
+    "ISAContext",
+    "ISAQuery",
+    "ISARefNode",
+    "ISARequirements",
+    "ISATransform",
+    "LatticeSurgery",
+    "PSSPC",
+    "property_name",
+    "property_name_to_key",
+    "Trace",
+    "TraceQuery",
+    "TraceTransform",
+    "LOGICAL",
+    "PHYSICAL",
+]