Try to decouple tq and qiskit, works on cuquantum qaoa example

zkysfls · zkysfls · commit d95848d601c9 · 2025-08-04T10:14:57.000-04:00
diff --git a/examples/cuquantum/qaoa.py b/examples/cuquantum/qaoa.py
@@ -12,8 +12,6 @@
 
 
 
-
-
 class MAXCUT(nn.Module):
     def __init__(self, n_wires, input_graph, n_layers):
         super().__init__()
diff --git a/torchquantum/__init__.py b/torchquantum/__init__.py
@@ -35,30 +35,36 @@
 from .layer import *
 from .encoding import *
 from .util import *
-from .noise_model import *
+# Note: noise_model requires qiskit and is not imported by default
+# from .noise_model import *
 from .algorithm import *
 from .dataset import *
 from .pulse import *
 
 # here we check whether the Qiskit parameterization bug is fixed, if not, a
 # warning message will be printed
-import qiskit
-import os
+# This is only done if qiskit is available
+try:
+    import qiskit
+    import os
 
-path = os.path.abspath(qiskit.__file__)
-# print(path)
-# path for aer provider
-path_provider = path.replace("__init__.py", "providers/aer/backends/aerbackend.py")
-# print(path_provider)
+    path = os.path.abspath(qiskit.__file__)
+    # print(path)
+    # path for aer provider
+    path_provider = path.replace("__init__.py", "providers/aer/backends/aerbackend.py")
+    # print(path_provider)
 
-# with open(path_provider, 'r') as fid:
-#     for line in fid.readlines():
-#         if 'FIXED' in line:
-#             # print('The qiskit parameterization bug is already fixed!')
-#             break
-#         else:
-#             print(f'\n\n WARNING: The qiskit parameterization bug is not '
-#                   f'fixed!\n\n'
-#                   f'run python fix_qiskit_parameterization.py to fix it!'
-#                   )
-#             break
+    # with open(path_provider, 'r') as fid:
+    #     for line in fid.readlines():
+    #         if 'FIXED' in line:
+    #             # print('The qiskit parameterization bug is already fixed!')
+    #             break
+    #         else:
+    #             print(f'\n\n WARNING: The qiskit parameterization bug is not '
+    #                   f'fixed!\n\n'
+    #                   f'run python fix_qiskit_parameterization.py to fix it!'
+    #                   )
+    #             break
+except ImportError:
+    # qiskit not available, skip the check
+    pass
diff --git a/torchquantum/layer/entanglement/entanglement.py b/torchquantum/layer/entanglement/entanglement.py
@@ -35,7 +35,7 @@
 from .op2_layer import Op2QAllLayer
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 __all__ = [
diff --git a/torchquantum/layer/entanglement/op2_layer.py b/torchquantum/layer/entanglement/op2_layer.py
@@ -30,7 +30,7 @@
 
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 __all__ = [
diff --git a/torchquantum/layer/layers/cx_layer.py b/torchquantum/layer/layers/cx_layer.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 
diff --git a/torchquantum/layer/layers/layers.py b/torchquantum/layer/layers/layers.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 from torchquantum.layer.entanglement.op2_layer import Op2QAllLayer
 
diff --git a/torchquantum/layer/layers/module_from_ops.py b/torchquantum/layer/layers/module_from_ops.py
@@ -30,7 +30,7 @@
 
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 __all__ = [
diff --git a/torchquantum/layer/layers/op_all.py b/torchquantum/layer/layers/op_all.py
@@ -30,7 +30,7 @@
 
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 __all__ = [
diff --git a/torchquantum/layer/layers/qft_layer.py b/torchquantum/layer/layers/qft_layer.py
@@ -5,7 +5,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 class QFTLayer(tq.QuantumModule):
diff --git a/torchquantum/layer/layers/random_layers.py b/torchquantum/layer/layers/random_layers.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 __all__ = [
diff --git a/torchquantum/layer/layers/ry_layer.py b/torchquantum/layer/layers/ry_layer.py
@@ -5,7 +5,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 from .layers import LayerTemplate0
diff --git a/torchquantum/layer/layers/seth_layer.py b/torchquantum/layer/layers/seth_layer.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 from .layers import LayerTemplate0, Op1QAllLayer
diff --git a/torchquantum/layer/layers/swap_layer.py b/torchquantum/layer/layers/swap_layer.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 from .layers import LayerTemplate0
diff --git a/torchquantum/layer/layers/u3_layer.py b/torchquantum/layer/layers/u3_layer.py
@@ -29,7 +29,7 @@
 import numpy as np
 
 from typing import Iterable
-from torchquantum.plugin.qiskit import QISKIT_INCOMPATIBLE_FUNC_NAMES
+from torchquantum.util.constants import QISKIT_INCOMPATIBLE_FUNC_NAMES
 from torchpack.utils.logging import logger
 
 from .layers import LayerTemplate0, Op1QAllLayer
diff --git a/torchquantum/noise_model/noise_models.py b/torchquantum/noise_model/noise_models.py
@@ -28,7 +28,7 @@
 
 from torchpack.utils.logging import logger
 from qiskit.providers.aer.noise import NoiseModel
-from torchquantum.util import get_provider
+from torchquantum.util.qiskit_utils import get_provider
 
 
 __all__ = [
diff --git a/torchquantum/plugin/__init__.py b/torchquantum/plugin/__init__.py
@@ -22,4 +22,9 @@
 SOFTWARE.
 """
 
-from .qiskit import *
+# Only import qiskit plugin if qiskit is available
+try:
+    from .qiskit import *
+except ImportError:
+    # qiskit not available, skip importing qiskit plugin
+    pass
diff --git a/torchquantum/plugin/qiskit/qiskit_processor.py b/torchquantum/plugin/qiskit/qiskit_processor.py
@@ -38,9 +38,11 @@
 )
 from torchquantum.util import (
     get_expectations_from_counts,
+    get_circ_stats,
+)
+from torchquantum.util.qiskit_utils import (
     get_provider,
     get_provider_hub_group_project,
-    get_circ_stats,
 )
 from .qiskit_macros import IBMQ_NAMES
 from tqdm import tqdm
diff --git a/torchquantum/util/__init__.py b/torchquantum/util/__init__.py
@@ -24,3 +24,4 @@
 
 from .utils import *
 from .vqe_utils import *
+from .constants import *
diff --git a/torchquantum/util/constants.py b/torchquantum/util/constants.py
@@ -0,0 +1,32 @@
+"""
+MIT License
+
+Copyright (c) 2020-present TorchQuantum Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+# Non-qiskit dependent constants that can be used throughout torchquantum
+
+# Function names that are incompatible with qiskit
+QISKIT_INCOMPATIBLE_FUNC_NAMES = [
+    "rot",
+    "multirz", 
+    "crot",
+]
diff --git a/torchquantum/util/qiskit_utils.py b/torchquantum/util/qiskit_utils.py
@@ -0,0 +1,152 @@
+"""
+MIT License
+
+Copyright (c) 2020-present TorchQuantum Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+# Qiskit-dependent utilities
+# This module isolates all qiskit dependencies to avoid import issues for non-qiskit users
+
+from torchpack.utils.logging import logger
+
+# Optional qiskit imports - only imported when functions are called
+def _import_qiskit_runtime():
+    try:
+        from qiskit_ibm_runtime import QiskitRuntimeService
+        return QiskitRuntimeService
+    except ImportError:
+        raise ImportError("qiskit_ibm_runtime is required for this functionality. Install with: pip install qiskit-ibm-runtime")
+
+def _import_qiskit_error():
+    try:
+        from qiskit.exceptions import QiskitError
+        return QiskitError
+    except ImportError:
+        raise ImportError("qiskit is required for this functionality. Install with: pip install qiskit")
+
+def _import_gate_error_values():
+    try:
+        from qiskit.providers.aer.noise.device.parameters import gate_error_values
+        return gate_error_values
+    except ImportError:
+        raise ImportError("qiskit-aer is required for this functionality. Install with: pip install qiskit-aer")
+
+
+def get_success_rate(properties, transpiled_circ):
+    """
+        Estimate the success rate of a transpiled quantum circuit.
+
+        Args:
+            properties (list): List of gate error properties.
+            transpiled_circ (QuantumCircuit): The transpiled quantum circuit.
+
+        Returns:
+            float: The estimated success rate.
+        """
+    # estimate the success rate according to the error rates of single and
+    # two-qubit gates in transpiled circuits
+
+    gate_error_values = _import_gate_error_values()
+    gate_errors = gate_error_values(properties)
+    # construct the error dict
+    gate_error_dict = {}
+    for gate_error in gate_errors:
+        if gate_error[0] not in gate_error_dict.keys():
+            gate_error_dict[gate_error[0]] = {tuple(gate_error[1]): gate_error[2]}
+        else:
+            gate_error_dict[gate_error[0]][tuple(gate_error[1])] = gate_error[2]
+
+    success_rate = 1
+
+    for instruction, qubits, cbit in transpiled_circ.data:
+        if instruction.name in gate_error_dict.keys():
+            if tuple(qubits) in gate_error_dict[instruction.name].keys():
+                gate_err = gate_error_dict[instruction.name][tuple(qubits)]
+                success_rate *= 1 - gate_err
+            else:
+                logger.warning(
+                    f"no error rate found for gate {instruction.name} on qubits {qubits}"
+                )
+
+    return success_rate
+
+
+def get_provider(backend_name, hub=None):
+    """
+        Get the provider object for a specific backend from IBM Quantum.
+
+        Args:
+            backend_name (str): Name of the backend.
+            hub (str): Optional hub name.
+
+        Returns:
+            IBMQProvider: The provider object.
+        """
+    QiskitRuntimeService = _import_qiskit_runtime()
+    QiskitError = _import_qiskit_error()
+    
+    # mass-inst-tech-1 or MIT-1
+    if backend_name in ["ibmq_casablanca", "ibmq_rome", "ibmq_bogota", "ibmq_jakarta"]:
+        if hub == "mass" or hub is None:
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/mass-inst-tech-1/main")
+        elif hub == "mit":
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/MIT-1/main")
+        else:
+            raise ValueError(f"not supported backend {backend_name} in hub " f"{hub}")
+    elif backend_name in [
+        "ibmq_paris",
+        "ibmq_toronto",
+        "ibmq_manhattan",
+        "ibmq_guadalupe",
+        "ibmq_montreal",
+    ]:
+        provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-ornl/anl/csc428")
+    else:
+        if hub == "mass" or hub is None:
+            try:
+                provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/mass-inst-tech-1/main")
+            except QiskitError:
+                # logger.warning(f"Cannot use MIT backend, roll back to open")
+                logger.warning(f"Use the open backend")
+                provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q/open/main")
+        elif hub == "mit":
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q-research/MIT-1/main")
+        else:
+            provider = QiskitRuntimeService(channel = "ibm_quantum", instance = "ibm-q/open/main")
+
+    return provider
+
+
+def get_provider_hub_group_project(hub="ibm-q", group="open", project="main"):
+    """
+        Get provider by specifying hub, group, and project.
+
+        Args:
+            hub (str): Hub name.
+            group (str): Group name.
+            project (str): Project name.
+
+        Returns:
+            IBMQProvider: The provider object.
+        """
+    QiskitRuntimeService = _import_qiskit_runtime()
+    provider = QiskitRuntimeService(channel = "ibm_quantum", instance = f"{hub}/{group}/{project}")
+    return provider
diff --git a/torchquantum/util/utils.py b/torchquantum/util/utils.py
