quarkcircuit 0.3.0.dev1__tar.gz → 0.3.0.dev2__tar.gz

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quarkcircuit
-Version: 0.3.0.dev1
+Version: 0.3.0.dev2
 Summary: Construction, visualization, and transpilation of quantum circuits
 Author-email: Xiaoxiao Xiao <xiaoxx@baqis.ac.cn>
 License-Expression: MIT
@@ -38,7 +38,7 @@ pip install quarkcircuit
 
 ## First experience
 
-See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/tanspiler/)
+See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/)
 
 ## License
 

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/README.md

@@ -26,7 +26,7 @@ pip install quarkcircuit
 
 ## First experience
 
-See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/tanspiler/)
+See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/)
 
 ## License
 

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "quarkcircuit"
-version = "0.3.0dev1"
+version = "0.3.0dev2"
 authors = [
   { name="Xiaoxiao Xiao", email="xiaoxx@baqis.ac.cn" }
 ]

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/quark/circuit/optimize.py

@@ -40,6 +40,9 @@ from .basepasses import TranspilerPass
 # 涉及大量dag读取操作，后期尝试rust加速
 class GateCompressor(TranspilerPass):
     """A transpiler pass that merges or compresses adjacent gates in a quantum circuit.
+
+    Args:
+        TranspilerPass (class): The base class that provides the structure for the transpiler pass.
     """
     def __init__(self):
         super().__init__()

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/quark/circuit/routing.py

@@ -91,8 +91,18 @@ def distance_matrix_element(qubit1:int,qubit2:int,coupling_graph:nx.Graph) -> in
     return dis 
 
 def mapping_node_to_gate_info(node:str,
-                              dag:'nx.DiGraph',
+                              dag:nx.DiGraph,
                               v2p:dict) -> tuple:
+    """Map a DAG node to its corresponding gate information. 
+
+    Args:
+        node (str): The identifier of the node in the DAG.
+        dag (nx.DiGraph): The DAG representing the quantum circuit.
+        v2p (dict): A dictionary mapping virtual qubits to physical qubits.
+
+    Returns:
+        tuple: A tuple containing gate information.
+    """
     gate = node.split('_')[0]
     if gate in one_qubit_gates_available.keys():
         qubit0 = dag.nodes[node]['qubits'][0]
@@ -131,7 +141,17 @@ def mapping_node_to_gate_info(node:str,
             gate_info = (gate,v2p[qubit0])      
     return gate_info 
 
-def is_correlation_on_front_layer(node, front_layer,dag):
+def is_correlation_on_front_layer(node:str, front_layer:list, dag:nx.DiGraph) -> bool:
+    """Check if the given node in the DAG is correlated with any node in the front layer.
+
+    Args:
+        node (str): The identifier of the node in the DAG.
+        front_layer (list): A list of node identifiers representing the front layer.
+        dag (nx.DiGraph): The directed acyclic graph (DAG) representing the quantum circuit.
+
+    Returns:
+        bool: True if the node is correlated with any node in the front layer, otherwise False.
+    """
     qubitlst = []
     for fnode in front_layer:
         qubits = dag.nodes[fnode]['qubits']
@@ -144,7 +164,19 @@ def is_correlation_on_front_layer(node, front_layer,dag):
     else:
         return False
 
-def update_v2p_and_p2v_mapping(v2p,swap_gate_info):
+def update_v2p_and_p2v_mapping(v2p:dict,swap_gate_info:tuple) -> tuple[dict,dict]:
+    """Update v2p and p2v mappings based on the given SWAP gate.
+
+    Args:
+        v2p (dict): A dictionary mapping virtual qubits to physical qubits.
+        swap_gate_info (tuple): A tuple containing gate information. The format is
+            (gate_name, vq1, vq2), where vq1 and vq2 are the virtual qubits being swapped.
+
+    Returns:
+        tuple[dict, dict]: 
+            - Updated v2p mapping after applying the SWAP.
+            - Updated p2v mapping.
+    """
     v2p = copy.deepcopy(v2p)
     vq1,vq2 = swap_gate_info[1:]
     v2p[vq1],v2p[vq2] = v2p[vq2],v2p[vq1]
@@ -152,8 +184,8 @@ def update_v2p_and_p2v_mapping(v2p,swap_gate_info):
     return v2p,p2v
 
 def heuristic_function_parallel(swap_gate_info: tuple,
-                                coupling_graph: 'nx.Graph',
-                                dag: 'nx.DiGraph', 
+                                coupling_graph: nx.Graph,
+                                dag: nx.DiGraph, 
                                 front_layer: list, 
                                 v2p:dict,
                                 decay_parameter: list,
@@ -197,9 +229,16 @@ def heuristic_function_parallel(swap_gate_info: tuple,
     #print('score',swap_gate_info,f_distance,size_F,W,e_distance,max_decay)
     return H
 
-def create_extended_successor_set(front_layer: list, dag: 'nx.DiGraph') -> list:
-    """Creates an extended set which contains some closet successors of the gates from F in the DAG
-    """    
+def create_extended_successor_set(front_layer: list, dag: nx.DiGraph) -> list:
+    """Create an extended set for the front layer.
+
+    Args:
+        front_layer (list): A list of node identifiers representing the front layer.
+        dag (nx.DiGraph): The directed acyclic graph (DAG) representing the quantum circuit.
+
+    Returns:
+        list: A list of node identifiers representing the extended set of the front layer.
+    """
     E = []
     for node in front_layer:
         for node_successor in dag.successors(node):
@@ -208,7 +247,17 @@ def create_extended_successor_set(front_layer: list, dag: 'nx.DiGraph') -> list:
                     E.append(node_successor)
     return list(set(E))
 
-def update_decay_parameter(min_score_swap_gate_info: tuple, decay_parameter: list,v2p:dict) -> list:    
+def update_decay_parameter(min_score_swap_gate_info: tuple, decay_parameter: list, v2p:dict) -> list:
+    """Update the decay parameter after applying the SWAP gate with the minimum score.
+
+    Args:
+        min_score_swap_gate_info (tuple): A tuple representing the SWAP gate with the minimum score.
+        decay_parameter (list):  A list of decay parameters, where each index corresponds to a physical qubit.
+        v2p (dict): A dictionary mapping virtual qubits to physical qubits.
+
+    Returns:
+        list: The updated list of decay parameters.
+    """
     min_score_swap_qubits = list(min_score_swap_gate_info[1:])
     pq1 = v2p[min_score_swap_qubits[0]]
     pq2 = v2p[min_score_swap_qubits[1]]
@@ -216,7 +265,31 @@ def update_decay_parameter(min_score_swap_gate_info: tuple, decay_parameter: lis
     decay_parameter[pq2] = decay_parameter[pq2] + 0.01
     return decay_parameter
 
-def gates_sabre_routing_once(dag,v2p,coupling_graph,largest_qubits_index,map_node_to_gate,do_random_choice:bool=False):
+def gates_sabre_routing_once(
+        dag:nx.DiGraph, 
+        v2p:dict, 
+        coupling_graph:nx.Graph, 
+        largest_qubits_index:int, 
+        map_node_to_gate:bool, 
+        do_random_choice:bool=False
+        ) -> tuple[list,dict]:
+    """Perform a single iteration of SABRE routing to generate gates and update v2p.
+
+    Args:
+        dag (nx.DiGraph): The directed acyclic graph (DAG) representing the quantum circuit.
+        v2p (dict): A dictionary mapping virtual qubits to physical qubits.
+        coupling_graph (nx.Graph): The coupling graph selected from the hardware, representing
+            only the physical qubits involved in the current circuit.
+        largest_qubits_index (int): The index of the largest physical qubit in the coupling graph.
+        map_node_to_gate (bool): Whether to map nodes in the DAG to corresponding gate operations.
+        do_random_choice (bool, optional): Whether to randomly choose a SWAP when multiple options 
+            have the same heuristic score. Defaults to False.
+
+    Returns:
+        tuple[list, dict]: 
+            - list: The list of gates generated after applying the SWAP sequence.
+            - dict: The updated v2p mapping after the SWAP operations.
+    """
     if len(v2p)>1:
         assert(len(coupling_graph.nodes)==len(v2p))
     p2v = {p:v for v,p in v2p.items()}
@@ -310,7 +383,27 @@ def gates_sabre_routing_once(dag,v2p,coupling_graph,largest_qubits_index,map_nod
     return new,v2p
 
 class SabreRouting(TranspilerPass):
+    """SABRE-based routing pass for quantum circuit transpilation.
+
+    Args:
+        TranspilerPass (class): The base class that provides the infrastructure for
+            the transpiler pass functionality.
+    """
     def __init__(self,subgraph:nx.Graph,initial_mapping:Literal['random','trivial']='trivial',do_random_choice:bool=False,iterations: int = 5):
+        """Initializes the SabreRouting class with the specified settings.
+
+        Args:
+            subgraph (nx.Graph): A subgraph of the hardware's coupling graph, containing 
+                only the physical qubits relevant for the current circuit.
+            initial_mapping (Literal['random','trivial'], optional): Strategy for initializing 
+                the virtual-to-physical qubit mapping. Options:
+                - 'trivial': Maps virtual qubits to physical qubits sequentially.
+                - 'random': Maps virtual qubits to physical qubits randomly.
+                Defaults to 'trivial'.
+            do_random_choice (bool, optional): If True, randomly chooses a SWAP when 
+                multiple options have the same score. Defaults to False.
+            iterations (int, optional): The number of iterations for the SABRE routing process. Defaults to 5.
+        """
         super().__init__()
         self.coupling_graph = subgraph
         self.initial_mapping = initial_mapping

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/quark/circuit/translate.py

@@ -39,8 +39,13 @@ from .decompose import (cx_decompose,
 from .basepasses import TranspilerPass
 
 class TranslateToBasisGates(TranspilerPass):
+    """Transpiler pass for converting quantum gates to hardware-specific basis gates.
+
+    Args:
+        TranspilerPass (class): The base class that provides the structure for the transpiler pass.
+    """
     def __init__(self,convert_single_qubit_gate_to_u:bool=True, two_qubit_gate_basis: Literal['cz','cx']='cz'):
-        """_summary_
+        """Initializes the TranslateToBasisGates class with the specified settings.
 
         Args:
             convert_single_qubit_gate_to_u (bool, optional): If True, converts all single-qubit gates into U3 gates. Defaults to True.

{quarkcircuit-0.3.0.dev1 → quarkcircuit-0.3.0.dev2}/quarkcircuit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quarkcircuit
-Version: 0.3.0.dev1
+Version: 0.3.0.dev2
 Summary: Construction, visualization, and transpilation of quantum circuits
 Author-email: Xiaoxiao Xiao <xiaoxx@baqis.ac.cn>
 License-Expression: MIT
@@ -38,7 +38,7 @@ pip install quarkcircuit
 
 ## First experience
 
-See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/tanspiler/)
+See [quarkcircuit example](https://quarkstudio.readthedocs.io/en/latest/usage/code/transpiler/)
 
 ## License