Deprecate CutQC

circuit_knitting/cutting/cutqc/__init__.py

@@ -11,6 +11,8 @@
 
 """Code to initialize the cutqc imports."""
 
+from warnings import warn
+
 from .wire_cutting_evaluation import run_subcircuit_instances
 from .wire_cutting_post_processing import generate_summation_terms, build
 from .wire_cutting_verification import verify
@@ -33,3 +35,11 @@
     "create_dd_bin",
     "reconstruct_dd_full_distribution",
 ]
+
+warn(
+    f"The package ``{__name__}`` is deprecated and will be removed no sooner than Circuit Knitting Toolbox v0.8.0. "
+    "The circuit cutting workflow in ``circuit_knitting.cutting`` now implements similar and improved functionalities, which will be maintained going forward."
+    " See https://qiskit-extensions.github.io/circuit-knitting-toolbox/circuit_cutting/tutorials/04_automatic_cut_finding.ipynb for a tutorial on the newly added automated cut-finding functionality.",
+    DeprecationWarning,
+    stacklevel=2,
+)

circuit_knitting/cutting/cutqc/dynamic_definition.py

@@ -46,10 +46,17 @@
 from typing import Sequence, Any
 from qiskit import QuantumCircuit
 from qiskit.circuit import Qubit
+from qiskit.utils.deprecation import deprecate_func
 
 from .wire_cutting_post_processing import build, find_process_jobs
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def dd_build(
     summation_terms: Sequence[dict[int, int]],
     subcircuit_entry_probs: dict[int, dict[int, np.ndarray]],
@@ -414,6 +421,12 @@ def _merge_states_into_bins(
     return merged_subcircuit_entry_probs
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def read_dd_bins(
     subcircuit_out_qubits: dict[int, list[int]], dd_bins: dict[int, dict[str, Any]]
 ) -> np.ndarray:
@@ -483,6 +496,12 @@ def read_dd_bins(
     return reconstructed_prob
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def get_reconstruction_qubit_order(
     full_circuit: QuantumCircuit,
     complete_path_map: dict[Qubit, list[dict[str, int | Qubit]]],

circuit_knitting/cutting/cutqc/mip_model.py

@@ -17,6 +17,8 @@
 
 import numpy as np
 
+from qiskit.utils.deprecation import deprecate_func
+
 
 class MIPModel(object):
     """
@@ -30,6 +32,12 @@ class MIPModel(object):
     can find the optimal wire cuts in the circuit.
     """
 
+    @deprecate_func(
+        removal_timeline="no sooner than CKT v0.8.0",
+        since="0.7.0",
+        package_name="circuit-knitting-toolbox",
+        additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+    )
     def __init__(
         self,
         n_vertices: int,
@@ -95,7 +103,7 @@ def __init__(
             from docplex.mp.model import Model
         except ModuleNotFoundError as ex:  # pragma: no cover
             raise ModuleNotFoundError(
-                "DOcplex is not installed.  For automatic cut finding to work, both "
+                "DOcplex is not installed.  For automatic cut-finding to work, both "
                 "DOcplex and cplex must be available."
             ) from ex
 

circuit_knitting/cutting/cutqc/wire_cutting.py

@@ -21,6 +21,7 @@
 from qiskit.dagcircuit import DAGCircuit, DAGOpNode
 from qiskit.converters import circuit_to_dag, dag_to_circuit
 from qiskit_ibm_runtime import Options, QiskitRuntimeService
+from qiskit.utils.deprecation import deprecate_func
 
 from .wire_cutting_evaluation import run_subcircuit_instances
 from .wire_cutting_post_processing import generate_summation_terms, build
@@ -32,6 +33,12 @@
 )
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def cut_circuit_wires(
     circuit: QuantumCircuit,
     method: str,
@@ -69,7 +76,7 @@ def cut_circuit_wires(
     if method == "automatic":
         if max_subcircuit_width is None:
             raise ValueError(
-                "The max_subcircuit_width argument must be set if using automatic cut finding."
+                "The max_subcircuit_width argument must be set if using automatic cut-finding."
             )
         cuts = find_wire_cuts(
             circuit=circuit,
@@ -96,6 +103,12 @@ def cut_circuit_wires(
     return cuts
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def evaluate_subcircuits(
     cuts: dict[str, Any],
     service: QiskitRuntimeService | None = None,
@@ -154,6 +167,12 @@ def evaluate_subcircuits(
     return subcircuit_instance_probabilities
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def reconstruct_full_distribution(
     circuit: QuantumCircuit,
     subcircuit_instance_probabilities: dict[int, dict[int, np.ndarray]],
@@ -196,6 +215,12 @@ def reconstruct_full_distribution(
     return reconstructed_probability
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def create_dd_bin(
     subcircuit_instance_probabilities: dict[int, dict[int, np.ndarray]],
     cuts: dict[str, Any],
@@ -235,6 +260,12 @@ def create_dd_bin(
     )
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def reconstruct_dd_full_distribution(
     circuit: QuantumCircuit,
     cuts: dict[str, Any],
@@ -385,6 +416,12 @@ def _attribute_shots(
 
 
 @no_type_check
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def find_wire_cuts(
     circuit: QuantumCircuit,
     max_subcircuit_width: int,
@@ -408,7 +445,7 @@ def find_wire_cuts(
         max_subcircuit_cuts: Max number of cuts for a subcircuit
         max_subcircuit_size: The maximum number of two qubit gates in each
             subcircuit
-        verbose: Whether to print information about the cut finding or not
+        verbose: Whether to print information about the cut-finding or not
 
     Returns:
         The solution found for the cuts
@@ -489,7 +526,7 @@ def find_wire_cuts(
 
         if best_mip_model is None:
             raise ValueError(
-                "Something went wrong during cut finding. The best MIP model object was never instantiated."
+                "Something went wrong during cut-finding. The best MIP model object was never instantiated."
             )
         print("Model objective value = %.2e" % (best_mip_model.objective), flush=True)  # type: ignore
         print("MIP runtime:", best_mip_model.runtime, flush=True)
@@ -502,6 +539,12 @@ def find_wire_cuts(
     return cut_solution
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def cut_circuit_wire(
     circuit: QuantumCircuit, subcircuit_vertices: Sequence[Sequence[int]], verbose: bool
 ) -> dict[str, Any]:

circuit_knitting/cutting/cutqc/wire_cutting_evaluation.py

@@ -21,13 +21,20 @@
 import numpy as np
 
 from qiskit import QuantumCircuit
+from qiskit.utils.deprecation import deprecate_func
 from qiskit.converters import circuit_to_dag, dag_to_circuit
 from qiskit.circuit.library.standard_gates import HGate, SGate, SdgGate, XGate
 from qiskit.primitives import BaseSampler, Sampler as TestSampler
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit_ibm_runtime import QiskitRuntimeService, Sampler, Session, Options
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def run_subcircuit_instances(
     subcircuits: Sequence[QuantumCircuit],
     subcircuit_instances: dict[int, dict[tuple[tuple[str, ...], tuple[Any, ...]], int]],
@@ -103,6 +110,12 @@ def run_subcircuit_instances(
     return subcircuit_instance_probs
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def mutate_measurement_basis(meas: tuple[str, ...]) -> list[tuple[Any, ...]]:
     """
     Change of basis for all identity measurements.
@@ -130,6 +143,12 @@ def mutate_measurement_basis(meas: tuple[str, ...]) -> list[tuple[Any, ...]]:
         return mutated_meas_out
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def modify_subcircuit_instance(
     subcircuit: QuantumCircuit, init: tuple[str, ...], meas: tuple[str, ...]
 ) -> QuantumCircuit:
@@ -210,6 +229,12 @@ def modify_subcircuit_instance(
     return subcircuit_instance_circuit
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def run_subcircuits_using_sampler(
     subcircuits: Sequence[QuantumCircuit],
     sampler: BaseSampler,
@@ -242,6 +267,12 @@ def run_subcircuits_using_sampler(
     return all_probabilities_out
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def run_subcircuits(
     subcircuits: Sequence[QuantumCircuit],
     service: QiskitRuntimeService | None = None,
@@ -275,6 +306,12 @@ def run_subcircuits(
     return run_subcircuits_using_sampler(subcircuits, sampler)
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def measure_prob(unmeasured_prob: np.ndarray, meas: tuple[Any, ...]) -> np.ndarray:
     """
     Compute the effective probability distribution from the subcircuit distribution.
@@ -298,6 +335,12 @@ def measure_prob(unmeasured_prob: np.ndarray, meas: tuple[Any, ...]) -> np.ndarr
         return measured_prob
 
 
+@deprecate_func(
+    removal_timeline="no sooner than CKT v0.8.0",
+    since="0.7.0",
+    package_name="circuit-knitting-toolbox",
+    additional_msg="Use the wire cutting or automated cut-finding functionality in the ``circuit_knitting.cutting`` package. ",
+)
 def measure_state(full_state: int, meas: tuple[Any, ...]) -> tuple[int, int]:
     """
     Compute the corresponding effective_state for the given full_state.