Prepare 0.23.0 release (#9438)

* Prepare 0.23.0 release

This commit prepares the 0.23.0 release, this involves 2 steps first
changing all the version numbers to 0.23.0 from 0.23.0rc1 and secondly
updating the release notes to prepare them for publishing.

One key thing to note is that this PR removes the 0.22.0 release notes.
This is because for the 0.22.0rc1 tag we neglected to move the release
notes to a separate directory. So when we did that for the 0.22.0 final
release we had to forward port this back to main so that any backports
to stable/0.22 would be backportable (see #8901). However, this causes
reno to detect all the 0.22 release notes are incorrectly as part of the
0.23.0 development series. To fix this the simplest path forward was to
remove the 0.22.0 release notes from the 0.23.0 branch (as in this PR).

* Remove backported PRs

* Start editting release note

* More updates

* Apply suggestions from code review

Co-authored-by: Julien Gacon <gaconju@gmail.com>

* Fix docs build errors

* More udpates

* Update more release notes

One release note to call out is the release note for #8568 has been
changed significantly. This is based on #9445 which is reverting some
breaking changes made as part of #8568.

* More updates

* Finish feature note first pass

* Start upgrade notes

* Move and update new release notes

* Fix docs build error

* Finish first pass at upgrade notes

* Finish first pass at deprecation notes

* Finish first pass over release notes

* Fix import cycle from dagcircuit

* Apply suggestions from code review

Co-authored-by: Kevin Hartman <kevin@hart.mn>

* Apply suggestions from code review

Co-authored-by: Jake Lishman <jake@binhbar.com>

* Update releasenotes/notes/0.23/prepare-0.23.0-release-0d954c91143cf9a4.yaml

* Fix analysis class definition in vf2 release note

Co-authored-by: Julien Gacon <gaconju@gmail.com>
Co-authored-by: Kevin Hartman <kevin@hart.mn>
Co-authored-by: Jake Lishman <jake@binhbar.com>

Author: 4 people

qiskit/VERSION.txt

@@ -1 +1 @@
-0.23.0rc1
+0.23.0

qiskit/algorithms/__init__.py

@@ -51,6 +51,7 @@
    Grover
    GroverResult
 
+.. _amplitude_estimators:
 
 Amplitude Estimators
 --------------------

qiskit/dagcircuit/__init__.py

@@ -31,6 +31,15 @@
    DAGDepNode
    DAGDependency
 
+Block Collection
+================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   BlockCollector
+   BlockCollapser
+
 Exceptions
 ==========
 
@@ -44,3 +53,4 @@
 from .dagdepnode import DAGDepNode
 from .exceptions import DAGCircuitError
 from .dagdependency import DAGDependency
+from .collect_blocks import BlockCollector, BlockCollapser

qiskit/dagcircuit/collect_blocks.py

@@ -15,12 +15,16 @@
 into smaller sub-blocks, and to consolidate blocks."""
 
 from qiskit.circuit import QuantumCircuit, CircuitInstruction
-from . import DAGOpNode, DAGCircuit, DAGDependency
-from .exceptions import DAGCircuitError
+from qiskit.dagcircuit.dagcircuit import DAGCircuit
+from qiskit.dagcircuit.dagnode import DAGOpNode
+from qiskit.dagcircuit.dagdependency import DAGDependency
+from qiskit.dagcircuit.exceptions import DAGCircuitError
 
 
 class BlockCollector:
-    """This class implements various strategies of dividing a DAG (direct acyclic graph)
+    """Class for implementing block collection on a DAG.
+
+    This class implements various strategies of dividing a DAG (direct acyclic graph)
     into blocks of nodes that satisfy certain criteria. It works both with the
     :class:`~qiskit.dagcircuit.DAGCircuit` and
     :class:`~qiskit.dagcircuit.DAGDependency` representations of a DAG, where
@@ -107,8 +111,11 @@ def _have_uncollected_nodes(self):
         return len(self._pending_nodes) > 0
 
     def collect_matching_block(self, filter_fn):
-        """Iteratively collects the largest block of input nodes (that is, nodes with
+        """Iteratively collects the largest block of input nodes
+
+        The largest block is the block that contains nodes with
         ``_in_degree`` equal to 0) that match a given filtering function.
+
         Examples of this include collecting blocks of swap gates,
         blocks of linear gates (CXs and SWAPs), blocks of Clifford gates, blocks of single-qubit gates,
         blocks of two-qubit gates, etc.  Here 'iteratively' means that once a node is collected,
@@ -143,13 +150,14 @@ def collect_matching_block(self, filter_fn):
 
     def collect_all_matching_blocks(self, filter_fn, split_blocks=True, min_block_size=2):
         """Collects all blocks that match a given filtering function filter_fn.
+
         This iteratively finds the largest block that does not match filter_fn,
         then the largest block that matches filter_fn, and so on, until no more uncollected
         nodes remain. Intuitively, finding larger blocks of non-matching nodes helps to
         find larger blocks of matching nodes later on.
 
         The option ``split_blocks`` allows to collected blocks into sub-blocks over
-        disjoint qubit subsets. The option ``min_block_size``specifies the minimum number
+        disjoint qubit subsets. The option ``min_block_size`` specifies the minimum number
         of gates in the block for the block to be collected.
 
         Returns the list of matching blocks only.
@@ -235,8 +243,10 @@ def run(self, block):
 
 
 class BlockCollapser:
-    """This class implements various strategies of consolidating blocks of nodes
-     in a DAG (direct acyclic graph). It works both with the
+    """Class to consolidate a given block from the dag into a single node
+
+    This class implements various strategies of consolidating blocks of nodes
+    in a DAG (direct acyclic graph). It works both with the
     :class:`~qiskit.dagcircuit.DAGCircuit` and
     :class:`~qiskit.dagcircuit.DAGDependency` DAG representations.
     """

qiskit/pulse/calibration_entries.py

@@ -11,6 +11,7 @@
 # that they have been altered from the originals.
 
 """Internal format of calibration data in target."""
+
 import inspect
 from abc import ABCMeta, abstractmethod
 from enum import IntEnum

qiskit/pulse/library/__init__.py

@@ -54,6 +54,7 @@
 
    Waveform
    SymbolicPulse
+   ScalableSymbolicPulse
    ParametricPulse
 
 

qiskit/transpiler/passes/__init__.py

@@ -74,6 +74,7 @@
    CollectMultiQBlocks
    CollectLinearFunctions
    CollectCliffords
+   CollectAndCollapse
    ConsolidateBlocks
    CXCancellation
    InverseCancellation
@@ -147,6 +148,17 @@
    SolovayKitaev
    SolovayKitaevSynthesis
 
+Synthesis Plugins
+=================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   SolovayKitaevSynthesis
+   BasicSynthesisPermutation
+   ACGSynthesisPermutation
+   KMSSynthesisPermutation
+
 Post Layout (Post transpile qubit selection)
 ============================================
 
@@ -232,6 +244,7 @@
 from .optimization import CollectCliffords
 from .optimization import ResetAfterMeasureSimplification
 from .optimization import OptimizeCliffords
+from .optimization import CollectAndCollapse
 
 # circuit analysis
 from .analysis import ResourceEstimation
@@ -251,6 +264,9 @@
 from .synthesis import HighLevelSynthesis
 from .synthesis import SolovayKitaev
 from .synthesis import SolovayKitaevSynthesis
+from .synthesis import BasicSynthesisPermutation
+from .synthesis import ACGSynthesisPermutation
+from .synthesis import KMSSynthesisPermutation
 
 # calibration
 from .calibration import PulseGates

qiskit/transpiler/passes/optimization/__init__.py

@@ -35,3 +35,4 @@
 from .reset_after_measure_simplification import ResetAfterMeasureSimplification
 from .optimize_cliffords import OptimizeCliffords
 from .collect_cliffords import CollectCliffords
+from .collect_and_collapse import CollectAndCollapse

qiskit/transpiler/passes/synthesis/__init__.py

@@ -15,5 +15,11 @@
 from .unitary_synthesis import UnitarySynthesis
 from .plugin import unitary_synthesis_plugin_names
 from .linear_functions_synthesis import LinearFunctionsSynthesis, LinearFunctionsToPermutations
-from .high_level_synthesis import HighLevelSynthesis, HLSConfig
+from .high_level_synthesis import (
+    HighLevelSynthesis,
+    HLSConfig,
+    BasicSynthesisPermutation,
+    ACGSynthesisPermutation,
+    KMSSynthesisPermutation,
+)
 from .solovay_kitaev_synthesis import SolovayKitaev, SolovayKitaevSynthesis

qiskit/transpiler/passes/synthesis/high_level_synthesis.py

@@ -174,7 +174,29 @@ def run(self, high_level_object, **options):
 
 
 class KMSSynthesisPermutation(HighLevelSynthesisPlugin):
-    """The permutation synthesis plugin based on the Kutin, Moulton, Smithline method."""
+    """The permutation synthesis plugin based on the Kutin, Moulton, Smithline method.
+
+
+    This plugin can be accessed by the ``kms`` method name in the
+    ``HLSConfig`` for ``permutation``. For example::
+
+        from qiskit.circuit import QuantumCircuit
+        from qiskit.circuit.library import PermutationGate
+        from qiskit.transpiler import PassManager
+        from qiskit.transpiler.passes.synthesis.high_level_synthesis import HLSConfig, HighLevelSynthesis
+        from qiskit.transpiler.passes.synthesis.plugin import HighLevelSynthesisPluginManager
+
+        # Create a permutation and add it to a quantum circuit
+        perm = PermutationGate([4, 6, 3, 7, 1, 2, 0, 5])
+        qc = QuantumCircuit(8)
+        qc.append(perm, range(8))
+
+        # KMSSynthesisPermutation plugin for permutations
+        # Returns a quantum circuit with size 18 and depth 6
+        # but adhering to the linear nearest-neighbor architecture.
+        qct = PassManager(HighLevelSynthesis(HLSConfig(permutation=[("kms", {})]))).run(qc)
+        print(f"kms: {qct.size() = }, {qct.depth() = }")
+    """
 
     def run(self, high_level_object, **options):
         """Run synthesis for the given Permutation."""
@@ -183,7 +205,27 @@ def run(self, high_level_object, **options):
 
 
 class BasicSynthesisPermutation(HighLevelSynthesisPlugin):
-    """The permutation synthesis plugin based on sorting."""
+    """The permutation synthesis plugin based on sorting.
+
+    This plugin can be accessed by the ``basic`` method name in the
+    ``HLSConfig`` for ``permutation``. For example::
+
+        from qiskit.circuit import QuantumCircuit
+        from qiskit.circuit.library import PermutationGate
+        from qiskit.transpiler import PassManager
+        from qiskit.transpiler.passes.synthesis.high_level_synthesis import HLSConfig, HighLevelSynthesis
+        from qiskit.transpiler.passes.synthesis.plugin import HighLevelSynthesisPluginManager
+
+        # Create a permutation and add it to a quantum circuit
+        perm = PermutationGate([4, 6, 3, 7, 1, 2, 0, 5])
+        qc = QuantumCircuit(8)
+        qc.append(perm, range(8))
+
+        # BasicSynthesisPermutation plugin for permutations
+        # Returns a quantum circuit with size 6 and depth 3
+        qct = PassManager(HighLevelSynthesis(HLSConfig(permutation=[("basic", {})]))).run(qc)
+        print(f"basic: {qct.size() = }, {qct.depth() = }")
+    """
 
     def run(self, high_level_object, **options):
         """Run synthesis for the given Permutation."""
@@ -192,7 +234,27 @@ def run(self, high_level_object, **options):
 
 
 class ACGSynthesisPermutation(HighLevelSynthesisPlugin):
-    """The permutation synthesis plugin based on the Alon, Chung, Graham method."""
+    """The permutation synthesis plugin based on the Alon, Chung, Graham method.
+
+    This plugin can be accessed by the ``acg`` method name in the
+    ``HLSConfig`` for ``permutation``. For example::
+
+        from qiskit.circuit import QuantumCircuit
+        from qiskit.circuit.library import PermutationGate
+        from qiskit.transpiler import PassManager
+        from qiskit.transpiler.passes.synthesis.high_level_synthesis import HLSConfig, HighLevelSynthesis
+        from qiskit.transpiler.passes.synthesis.plugin import HighLevelSynthesisPluginManager
+
+        # Create a permutation and add it to a quantum circuit
+        perm = PermutationGate([4, 6, 3, 7, 1, 2, 0, 5])
+        qc = QuantumCircuit(8)
+        qc.append(perm, range(8))
+
+        # ACGSynthesisPermutation plugin for permutations
+        # Returns a quantum circuit with size 6 and depth 2
+        qct = PassManager(HighLevelSynthesis(HLSConfig(permutation=[("acg", {})]))).run(qc)
+        print(f"acg: {qct.size() = }, {qct.depth() = }")
+    """
 
     def run(self, high_level_object, **options):
         """Run synthesis for the given Permutation."""