LO circuit cuts optimizer

.github/workflows/lint.yml

@@ -18,10 +18,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - name: Install tox
         run: |
           python -m pip install --upgrade pip

circuit_knitting/cutting/__init__.py

@@ -21,6 +21,7 @@
     :toctree: ../stubs/
     :nosignatures:
 
+    find_cuts
     cut_wires
     expand_observables
     partition_circuit_qubits
@@ -60,6 +61,17 @@
     qpd.decompose_qpd_instructions
     qpd.qpdbasis_from_instruction
 
+Automatic Cut Finding
+=====================
+
+.. autosummary::
+    :toctree: ../stubs/
+    :nosignatures:
+    :template: autosummary/class_no_inherited_members.rst
+
+    cut_finding.OptimizationParameters
+    cut_finding.DeviceConstraints
+
 CutQC
 =====
 
@@ -82,11 +94,15 @@
     cut_gates,
     PartitionedCuttingProblem,
 )
+from .find_cuts import find_cuts
 from .cutting_experiments import generate_cutting_experiments
 from .cutting_reconstruction import reconstruct_expectation_values
 from .wire_cutting_transforms import cut_wires, expand_observables
+from .cut_finding.quantum_device_constraints import DeviceConstraints
+from .cut_finding.optimization_settings import OptimizationParameters
 
 __all__ = [
+    "find_cuts",
     "partition_circuit_qubits",
     "partition_problem",
     "cut_gates",
@@ -95,4 +111,6 @@
     "PartitionedCuttingProblem",
     "cut_wires",
     "expand_observables",
+    "DeviceConstraints",
+    "OptimizationParameters",
 ]

circuit_knitting/cutting/cut_finding/__init__.py

@@ -0,0 +1,15 @@
+# (C) Copyright IBM 2024.
+
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Main automated cut finding functionality."""
+
+from .optimization_settings import OptimizationParameters
+from .quantum_device_constraints import DeviceConstraints
+
+__all__ = ["DeviceConstraints", "OptimizationParameters"]