bloqade-circuit 0.4.4__tar.gz → 0.4.5__tar.gz

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bloqade-circuit
-Version: 0.4.4
+Version: 0.4.5
 Summary: The software development toolkit for neutral atom arrays.
 Author-email: Roger-luo <rluo@quera.com>, kaihsin <khwu@quera.com>, weinbe58 <pweinberg@quera.com>, johnzl-777 <jlong@quera.com>
 License-File: LICENSE

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bloqade-circuit"
-version = "0.4.4"
+version = "0.4.5"
 description = "The software development toolkit for neutral atom arrays."
 readme = "README.md"
 authors = [

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/src/bloqade/squin/cirq/__init__.py

@@ -9,8 +9,9 @@ from . import lowering as lowering
 from .. import kernel
 
 # NOTE: just to register methods
-from .emit import op as op, qubit as qubit
+from .emit import op as op, noise as noise, qubit as qubit
 from .lowering import Squin
+from ..noise.rewrite import RewriteNoiseStmts
 from .emit.emit_circuit import EmitCirq
 
 
@@ -18,6 +19,9 @@ def load_circuit(
     circuit: cirq.Circuit,
     kernel_name: str = "main",
     dialects: ir.DialectGroup = kernel,
+    register_as_argument: bool = False,
+    return_register: bool = False,
+    register_argument_name: str = "q",
     globals: dict[str, Any] | None = None,
     file: str | None = None,
     lineno_offset: int = 0,
@@ -32,13 +36,23 @@ def load_circuit(
     Keyword Args:
         kernel_name (str): The name of the kernel to load. Defaults to "main".
         dialects (ir.DialectGroup | None): The dialects to use. Defaults to `squin.kernel`.
+        register_as_argument (bool): Determine whether the resulting kernel function should accept
+            a single `ilist.IList[Qubit, Any]` argument that is a list of qubits used within the
+            function. This allows you to compose kernel functions generated from circuits.
+            Defaults to `False`.
+        return_register (bool): Determine whether the resulting kernel functionr returns a
+            single value of type `ilist.IList[Qubit, Any]` that is the list of qubits used
+            in the kernel function. Useful when you want to compose multiple kernel functions
+            generated from circuits. Defaults to `False`.
+        register_argument_name (str): The name of the argument that represents the qubit register.
+            Only used when `register_as_argument=True`. Defaults to "q".
         globals (dict[str, Any] | None): The global variables to use. Defaults to None.
         file (str | None): The file name for error reporting. Defaults to None.
         lineno_offset (int): The line number offset for error reporting. Defaults to 0.
         col_offset (int): The column number offset for error reporting. Defaults to 0.
         compactify (bool): Whether to compactify the output. Defaults to True.
 
-    Example:
+    ## Usage Examples:
 
     ```python
     # from cirq's "hello qubit" example
@@ -60,6 +74,30 @@ def load_circuit(
     # print the resulting IR
     main.print()
     ```
+
+    You can also compose kernel functions generated from circuits by passing in
+    and / or returning the respective quantum registers:
+
+    ```python
+    q = cirq.LineQubit.range(2)
+    circuit = cirq.Circuit(cirq.H(q[0]), cirq.CX(*q))
+
+    get_entangled_qubits = squin.cirq.load_circuit(
+        circuit, return_register=True, kernel_name="get_entangled_qubits"
+    )
+    get_entangled_qubits.print()
+
+    entangle_qubits = squin.cirq.load_circuit(
+        circuit, register_as_argument=True, kernel_name="entangle_qubits"
+    )
+
+    @squin.kernel
+    def main():
+        qreg = get_entangled_qubits()
+        qreg2 = squin.qubit.new(1)
+        entangle_qubits([qreg[1], qreg2[0]])
+        return squin.qubit.measure(qreg2)
+    ```
     """
 
     target = Squin(dialects=dialects, circuit=circuit)
@@ -71,16 +109,38 @@ def load_circuit(
         lineno_offset=lineno_offset,
         col_offset=col_offset,
         compactify=compactify,
+        register_as_argument=register_as_argument,
+        register_argument_name=register_argument_name,
     )
 
-    # NOTE: no return value
-    return_value = func.ConstantNone()
-    body.blocks[0].stmts.append(return_value)
-    body.blocks[0].stmts.append(func.Return(value_or_stmt=return_value))
+    if return_register:
+        return_value = target.qreg
+    else:
+        return_value = func.ConstantNone()
+        body.blocks[0].stmts.append(return_value)
+
+    return_node = func.Return(value_or_stmt=return_value)
+    body.blocks[0].stmts.append(return_node)
+
+    self_arg_name = kernel_name + "_self"
+    arg_names = [self_arg_name]
+    if register_as_argument:
+        args = (target.qreg.type,)
+        arg_names.append(register_argument_name)
+    else:
+        args = ()
+
+    # NOTE: add _self as argument; need to know signature before so do it after lowering
+    signature = func.Signature(args, return_node.value.type)
+    body.blocks[0].args.insert_from(
+        0,
+        types.Generic(ir.Method, types.Tuple.where(signature.inputs), signature.output),
+        self_arg_name,
+    )
 
     code = func.Function(
         sym_name=kernel_name,
-        signature=func.Signature((), types.NoneType),
+        signature=signature,
         body=body,
     )
 
@@ -88,7 +148,7 @@ def load_circuit(
         mod=None,
         py_func=None,
         sym_name=kernel_name,
-        arg_names=[],
+        arg_names=arg_names,
         dialects=dialects,
         code=code,
     )
@@ -176,7 +236,12 @@ def emit_circuit(
         )
 
     emitter = EmitCirq(qubits=qubits)
-    return emitter.run(mt, args=())
+
+    # Rewrite noise statements
+    mt_ = mt.similar(mt.dialects)
+    RewriteNoiseStmts(mt_.dialects)(mt_)
+
+    return emitter.run(mt_, args=())
 
 
 def dump_circuit(mt: ir.Method, qubits: Sequence[cirq.Qid] | None = None, **kwargs):

bloqade_circuit-0.4.5/src/bloqade/squin/cirq/emit/noise.py

@@ -0,0 +1,49 @@
+import cirq
+from kirin.emit import EmitError
+from kirin.interp import MethodTable, impl
+
+from ... import noise
+from .runtime import (
+    KronRuntime,
+    BasicOpRuntime,
+    OperatorRuntimeABC,
+    PauliStringRuntime,
+)
+from .emit_circuit import EmitCirq, EmitCirqFrame
+
+
+@noise.dialect.register(key="emit.cirq")
+class EmitCirqNoiseMethods(MethodTable):
+
+    @impl(noise.stmts.StochasticUnitaryChannel)
+    def stochastic_unitary_channel(
+        self,
+        emit: EmitCirq,
+        frame: EmitCirqFrame,
+        stmt: noise.stmts.StochasticUnitaryChannel,
+    ):
+        ops = frame.get(stmt.operators)
+        ps = frame.get(stmt.probabilities)
+
+        error_probabilities = {self._op_to_key(op_): p for op_, p in zip(ops, ps)}
+        cirq_op = cirq.asymmetric_depolarize(error_probabilities=error_probabilities)
+        return (BasicOpRuntime(cirq_op),)
+
+    @staticmethod
+    def _op_to_key(operator: OperatorRuntimeABC) -> str:
+        match operator:
+            case KronRuntime():
+                key_lhs = EmitCirqNoiseMethods._op_to_key(operator.lhs)
+                key_rhs = EmitCirqNoiseMethods._op_to_key(operator.rhs)
+                return key_lhs + key_rhs
+
+            case BasicOpRuntime():
+                return str(operator.gate)
+
+            case PauliStringRuntime():
+                return operator.string
+
+            case _:
+                raise EmitError(
+                    f"Unexpected operator runtime in StochasticUnitaryChannel of type {type(operator).__name__} encountered!"
+                )

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/src/bloqade/squin/cirq/emit/runtime.py

@@ -21,7 +21,10 @@ class OperatorRuntimeABC:
 
     def unsafe_apply(
         self, qubits: Sequence[cirq.Qid], adjoint: bool = False
-    ) -> list[cirq.Operation]: ...
+    ) -> list[cirq.Operation]:
+        raise NotImplementedError(
+            f"Apply method needs to be implemented in {self.__class__.__name__}"
+        )
 
 
 @dataclass
@@ -38,6 +41,11 @@ class BasicOpRuntime(UnsafeOperatorRuntimeABC):
     def num_qubits(self) -> int:
         return self.gate.num_qubits()
 
+    def unsafe_apply(
+        self, qubits: Sequence[cirq.Qid], adjoint: bool = False
+    ) -> list[cirq.Operation]:
+        return [self.gate(*qubits)]
+
 
 @dataclass
 class UnitaryRuntime(BasicOpRuntime):

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/src/bloqade/squin/cirq/lowering.py

@@ -3,7 +3,7 @@ from typing import Any
 from dataclasses import field, dataclass
 
 import cirq
-from kirin import ir, lowering
+from kirin import ir, types, lowering
 from kirin.rewrite import Walk, CFGCompactify
 from kirin.dialects import py, scf, ilist
 
@@ -25,27 +25,26 @@ class Squin(lowering.LoweringABC[CirqNode]):
     """Lower a cirq.Circuit object to a squin kernel"""
 
     circuit: cirq.Circuit
-    qreg: qubit.New = field(init=False)
+    qreg: ir.SSAValue = field(init=False)
     qreg_index: dict[cirq.Qid, int] = field(init=False, default_factory=dict)
     next_qreg_index: int = field(init=False, default=0)
 
-    def lower_qubit_getindex(self, state: lowering.State[CirqNode], qid: cirq.Qid):
-        index = self.qreg_index.get(qid)
-
-        if index is None:
-            index = self.next_qreg_index
-            self.qreg_index[qid] = index
-            self.next_qreg_index += 1
+    def __post_init__(self):
+        # TODO: sort by cirq ordering
+        qbits = sorted(self.circuit.all_qubits())
+        self.qreg_index = {qid: idx for (idx, qid) in enumerate(qbits)}
 
+    def lower_qubit_getindex(self, state: lowering.State[CirqNode], qid: cirq.Qid):
+        index = self.qreg_index[qid]
         index_ssa = state.current_frame.push(py.Constant(index)).result
-        qbit_getitem = state.current_frame.push(py.GetItem(self.qreg.result, index_ssa))
+        qbit_getitem = state.current_frame.push(py.GetItem(self.qreg, index_ssa))
         return qbit_getitem.result
 
     def lower_qubit_getindices(
         self, state: lowering.State[CirqNode], qids: list[cirq.Qid]
     ):
         qbits_getitem = [self.lower_qubit_getindex(state, qid) for qid in qids]
-        qbits_stmt = ilist.New(values=qbits_getitem)
+        qbits_stmt = ilist.New(values=qbits_getitem, elem_type=qubit.QubitType)
         qbits_result = state.current_frame.get(qbits_stmt.name)
 
         if qbits_result is not None:
@@ -64,6 +63,8 @@ class Squin(lowering.LoweringABC[CirqNode]):
         lineno_offset: int = 0,
         col_offset: int = 0,
         compactify: bool = True,
+        register_as_argument: bool = False,
+        register_argument_name: str = "q",
     ) -> ir.Region:
 
         state = lowering.State(
@@ -73,16 +74,21 @@ class Squin(lowering.LoweringABC[CirqNode]):
             col_offset=col_offset,
         )
 
-        with state.frame(
-            [stmt],
-            globals=globals,
-            finalize_next=False,
-        ) as frame:
-            # NOTE: create a global register of qubits first
-            # TODO: can there be a circuit without qubits?
-            n_qubits = cirq.num_qubits(self.circuit)
-            n = frame.push(py.Constant(n_qubits))
-            self.qreg = frame.push(qubit.New(n_qubits=n.result))
+        with state.frame([stmt], globals=globals, finalize_next=False) as frame:
+
+            # NOTE: need a register of qubits before lowering statements
+            if register_as_argument:
+                # NOTE: register as argument to the kernel; we have freedom of choice for the name here
+                frame.curr_block.args.append_from(
+                    ilist.IListType[qubit.QubitType, types.Any],
+                    name=register_argument_name,
+                )
+                self.qreg = frame.curr_block.args[0]
+            else:
+                # NOTE: create a new register of appropriate size
+                n_qubits = len(self.qreg_index)
+                n = frame.push(py.Constant(n_qubits))
+                self.qreg = frame.push(qubit.New(n_qubits=n.result)).result
 
             self.visit(state, stmt)
 

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/src/bloqade/squin/noise/_wrapper.py

@@ -1,3 +1,6 @@
+from typing import Literal
+
+from kirin.dialects import ilist
 from kirin.lowering import wraps
 
 from bloqade.squin.op.types import Op
@@ -18,11 +21,15 @@ def depolarize(p: float) -> Op: ...
 
 
 @wraps(stmts.SingleQubitPauliChannel)
-def single_qubit_pauli_channel(params: tuple[float, float, float]) -> Op: ...
+def single_qubit_pauli_channel(
+    params: ilist.IList[float, Literal[3]] | list[float] | tuple[float, float, float],
+) -> Op: ...
 
 
 @wraps(stmts.TwoQubitPauliChannel)
-def two_qubit_pauli_channel(params: tuple[float, ...]) -> Op: ...
+def two_qubit_pauli_channel(
+    params: ilist.IList[float, Literal[15]] | list[float] | tuple[float, ...],
+) -> Op: ...
 
 
 @wraps(stmts.QubitLoss)

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/src/bloqade/squin/noise/rewrite.py

@@ -58,12 +58,12 @@ class _RewriteNoiseStmts(RewriteRule):
     def rewrite_two_qubit_pauli_channel(
         self, node: TwoQubitPauliChannel
     ) -> RewriteResult:
-        paulis = (X(), Y(), Z(), Identity(sites=1))
+        paulis = (Identity(sites=1), X(), Y(), Z())
         for op in paulis:
             op.insert_before(node)
 
-        # NOTE: collect list so we can skip the last entry, which will be two identities
-        combinations = list(itertools.product(paulis, repeat=2))[:-1]
+        # NOTE: collect list so we can skip the first entry, which will be two identities
+        combinations = list(itertools.product(paulis, repeat=2))[1:]
         operators: list[ir.SSAValue] = []
         for pauli_1, pauli_2 in combinations:
             op = Kron(pauli_1.result, pauli_2.result)

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/test/squin/cirq/test_cirq_to_squin.py

@@ -2,6 +2,9 @@ import math
 
 import cirq
 import pytest
+from kirin import types
+from kirin.passes import inline
+from kirin.dialects import ilist
 
 from bloqade import squin
 from bloqade.pyqrack import DynamicMemorySimulator
@@ -124,6 +127,19 @@ def noise_channels():
     )
 
 
+def nested_circuit():
+    q = cirq.LineQubit.range(3)
+
+    return cirq.Circuit(
+        cirq.H(q[0]),
+        cirq.CircuitOperation(
+            cirq.Circuit(cirq.H(q[1]), cirq.CX(q[1], q[2])).freeze(),
+            use_repetition_ids=False,
+        ).controlled_by(q[0]),
+        cirq.measure(*q),
+    )
+
+
 @pytest.mark.parametrize(
     "circuit_f",
     [
@@ -161,6 +177,66 @@ def test_circuit(circuit_f, run_sim: bool = False):
     print(ket)
 
 
+def test_return_register():
+    circuit = basic_circuit()
+    kernel = squin.load_circuit(circuit, return_register=True)
+    kernel.print()
+
+    assert isinstance(kernel.return_type, types.Generic)
+    assert kernel.return_type.body.is_subseteq(ilist.IListType)
+
+
+@pytest.mark.xfail
+def test_nested_circuit():
+    # TODO: lowering for CircuitOperation
+    test_circuit(nested_circuit)
+
+
+def test_passing_in_register():
+    circuit = pow_gate_circuit()
+    print(circuit)
+    kernel = squin.cirq.load_circuit(circuit, register_as_argument=True)
+    kernel.print()
+
+
+def test_passing_and_returning_register():
+    circuit = pow_gate_circuit()
+    print(circuit)
+    kernel = squin.cirq.load_circuit(
+        circuit, register_as_argument=True, return_register=True
+    )
+    kernel.print()
+
+
+def test_nesting_lowered_circuit():
+    q = cirq.LineQubit.range(2)
+    circuit = cirq.Circuit(cirq.H(q[0]), cirq.CX(*q))
+
+    get_entangled_qubits = squin.cirq.load_circuit(
+        circuit, return_register=True, kernel_name="get_entangled_qubits"
+    )
+    get_entangled_qubits.print()
+
+    entangle_qubits = squin.cirq.load_circuit(
+        circuit, register_as_argument=True, kernel_name="entangle_qubits"
+    )
+
+    @squin.kernel
+    def main():
+        qreg = get_entangled_qubits()
+        qreg2 = squin.qubit.new(1)
+        entangle_qubits([qreg[1], qreg2[0]])
+        return squin.qubit.measure(qreg2)
+
+    # if you get up to here, the validation works
+    main.print()
+
+    # inline to see if the IR is correct
+    inline.InlinePass(main.dialects)(main)
+
+    main.print()
+
+
 def test_classical_control(run_sim: bool = False):
     q = cirq.LineQubit.range(2)
     circuit = cirq.Circuit(

bloqade_circuit-0.4.5/test/squin/cirq/test_squin_noise_to_cirq.py

@@ -0,0 +1,88 @@
+import cirq
+
+from bloqade import squin
+
+
+def test_pauli_channel(run_sim: bool = False):
+    @squin.kernel
+    def main():
+        q = squin.qubit.new(2)
+        h = squin.op.h()
+        cx = squin.op.cx()
+        squin.qubit.apply(h, q[0])
+        dpl = squin.noise.depolarize(0.1)
+        squin.qubit.apply(dpl, q[0])
+        squin.qubit.apply(cx, q)
+        single_qubit_noise = squin.noise.single_qubit_pauli_channel([0.1, 0.12, 0.13])
+        squin.qubit.apply(single_qubit_noise, q[1])
+        two_qubit_noise = squin.noise.two_qubit_pauli_channel(
+            [
+                0.036,
+                0.007,
+                0.035,
+                0.022,
+                0.063,
+                0.024,
+                0.006,
+                0.033,
+                0.014,
+                0.019,
+                0.023,
+                0.058,
+                0.0,
+                0.0,
+                0.064,
+            ]
+        )
+        squin.qubit.apply(two_qubit_noise, q)
+        squin.qubit.measure(q)
+
+    main.print()
+
+    circuit = squin.cirq.emit_circuit(main)
+
+    print(circuit)
+
+    if run_sim:
+        sim = cirq.Simulator()
+        sim.run(circuit)
+
+
+def test_pauli_error(run_sim: bool = False):
+    @squin.kernel
+    def main():
+        q = squin.qubit.new(2)
+        x = squin.op.x()
+        n = squin.noise.pauli_error(x, 0.1)
+        squin.qubit.apply(n, q[0])
+        squin.qubit.measure(q)
+
+    main.print()
+
+    circuit = squin.cirq.emit_circuit(main)
+
+    print(circuit)
+
+    if run_sim:
+        sim = cirq.Simulator()
+        sim.run(circuit)
+
+
+def test_pperror(run_sim: bool = False):
+    @squin.kernel
+    def main():
+        q = squin.qubit.new(3)
+        ps = squin.op.pauli_string(string="XYZ")
+        n = squin.noise.pp_error(ps, 0.1)
+        squin.qubit.apply(n, q)
+        squin.qubit.measure(q)
+
+    main.print()
+
+    circuit = squin.cirq.emit_circuit(main)
+
+    print(circuit)
+
+    if run_sim:
+        sim = cirq.Simulator()
+        sim.run(circuit)

{bloqade_circuit-0.4.4 → bloqade_circuit-0.4.5}/uv.lock

@@ -96,7 +96,7 @@ wheels = [
 
 [[package]]
 name = "bloqade-circuit"
-version = "0.4.4"
+version = "0.4.5"
 source = { editable = "." }
 dependencies = [
     { name = "kirin-toolchain" },