Finalizing 1.3 release (#13502)

* Fix various 1.3 release notes links Co-authored-by: Max Rossmannek <[email protected]> * more links * fix unitaties Co-authored-by: Eli Arbel <[email protected]> * mention how to get the old basis trafo * rm non-documented pulse_drawer --------- Co-authored-by: Max Rossmannek <[email protected]> Co-authored-by: Eli Arbel <[email protected]>
Qiskit · Nov 28, 2024 · 896d1c8 · 896d1c8
1 parent cda7ef6
commit 896d1c8
Show file tree

Hide file tree

Showing 22 changed files with 45 additions and 40 deletions.
diff --git a/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py b/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py
@@ -84,7 +84,7 @@ class CDKMRippleCarryAdder(Adder):
         :class:`.ModularAdderGate`: A generic inplace adder, modulo :math:`2^n`. This
             is functionally equivalent to ``kind="fixed"``.
 
-        :class:`.AdderGate`: A generic inplace adder. This
+        :class:`.HalfAdderGate`: A generic inplace adder. This
             is functionally equivalent to ``kind="half"``.
 
         :class:`.FullAdderGate`: A generic inplace adder, with a carry-in bit. This

diff --git a/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py b/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py
@@ -54,7 +54,7 @@ class DraperQFTAdder(Adder):
         :class:`.ModularAdderGate`: A generic inplace adder, modulo :math:`2^n`. This
             is functionally equivalent to ``kind="fixed"``.
 
-        :class:`.AdderGate`: A generic inplace adder. This
+        :class:`.HalfAdderGate`: A generic inplace adder. This
             is functionally equivalent to ``kind="half"``.
 
     **References:**

diff --git a/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py b/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py
@@ -60,7 +60,7 @@ class VBERippleCarryAdder(Adder):
         :class:`.ModularAdderGate`: A generic inplace adder, modulo :math:`2^n`. This
             is functionally equivalent to ``kind="fixed"``.
 
-        :class:`.AdderGate`: A generic inplace adder. This
+        :class:`.HalfAdderGate`: A generic inplace adder. This
             is functionally equivalent to ``kind="half"``.
 
         :class:`.FullAdderGate`: A generic inplace adder, with a carry-in bit. This

diff --git a/qiskit/transpiler/passes/synthesis/hls_plugins.py b/qiskit/transpiler/passes/synthesis/hls_plugins.py
@@ -376,7 +376,7 @@
       - Description
     * - ``"cumulative"``
       - :class:`.MultiplierSynthesisH18`
-      - depending on the :class:`.AdderGate` used
+      - depending on the :class:`.HalfAdderGate` used
       - a cumulative adder based on controlled adders
     * - ``"qft"``
       - :class:`.MultiplierSynthesisR17`

diff --git a/releasenotes/notes/1.3/add-gates-to-collect-clifford-af88dd8f7a2a4bf9.yaml b/releasenotes/notes/1.3/add-gates-to-collect-clifford-af88dd8f7a2a4bf9.yaml
@@ -2,7 +2,7 @@
 features_transpiler:
   - |
     Add argument ``matrix_based`` to the :class:`.CollectCliffords` transpiler pass.
-    If the new parameter ``matrix_based=True``, the :class:`.CollectCliffords()` transpiler pass
-    can collect :class:`.RZGate(np.pi/2)` gates and other unitary gates that are :class:`.Clifford()`
-    gates for certain parameters.
+    If the new parameter ``matrix_based=True``, the :class:`.CollectCliffords` transpiler pass
+    can collect unitary gates that are Clifford gates for certain parameters, for example
+    :class:`.RZGate` gates with angles that are multiples of :math:`\pi / 2`.
 
diff --git a/releasenotes/notes/1.3/add-qpy-v13-3b22ae33045af6c1.yaml b/releasenotes/notes/1.3/add-qpy-v13-3b22ae33045af6c1.yaml
@@ -6,7 +6,7 @@ features_qpy:
 issues:
   - |
     When using QPY formats 10, 11, or 12 with circuits that contain
-    :class:`.ParamerExpression`\s, if the version of the ``symengine`` package
+    :class:`.ParameterExpression`\s, if the version of the ``symengine`` package
     installed in the environment that generated the payload (:func:`.qpy.dump`) does
     not match the version of ``symengine`` installed in the enviroment where the
     payload is loaded (:func:`.qpy.load`), you will get an error. If you encounter

diff --git a/releasenotes/notes/1.3/binary-arithmetic-gates-6cd2b1c8112febe0.yaml b/releasenotes/notes/1.3/binary-arithmetic-gates-6cd2b1c8112febe0.yaml
@@ -3,8 +3,9 @@ features_circuits:
   - |
     Added binary arithmetic gates for inplace addition of two :math:`n`-qubit registers,
     that is :math:`|a\rangle |b\rangle \mapsto |a\rangle |a+b\rangle`.
-    The :class:`.ModularAdderGate` implements addition modulo :math:`2^n`, and the
-    :class:`.FullAdderGate` includes a carry-in qubit. See the respective documentation for
+    The :class:`.ModularAdderGate` implements addition modulo :math:`2^n`, the
+    :class:`.HalfAdderGate` includes a carry-out qubit, and the :class:`.FullAdderGate` includes
+    both a carry-in and a carry-out qubit. See the respective documentation for
     details and examples.
 
     In contrast to the existing library circuits, such as :class:`.CDKMRippleCarryAdder`,

diff --git a/releasenotes/notes/1.3/dag-oxide-60b3d7219cb21703.yaml b/releasenotes/notes/1.3/dag-oxide-60b3d7219cb21703.yaml
@@ -28,8 +28,8 @@ upgrade_transpiler:
 
     however this type of mutation was always unsound as it could break the DAG's internal caching
     and cause corruption of the data structure. Instead you should use the API provided by
-    :class:`.DAGCircuit` for mutation such as :meth:`.DAGCircuit.substitute_node`,
-    :meth:`.DAGCircuit.substitute_node_with_dag`, or :meth:`.DAGCircuit.contract_node`. For example
+    :class:`.DAGCircuit` for mutation such as :meth:`.DAGCircuit.substitute_node` or
+    :meth:`.DAGCircuit.substitute_node_with_dag`. For example
     the above code block would become::
 
         for node in dag.op_nodes():

diff --git a/releasenotes/notes/1.3/deprecate-basic-simulator-configuration-9d782925196993e9.yaml b/releasenotes/notes/1.3/deprecate-basic-simulator-configuration-9d782925196993e9.yaml
@@ -8,7 +8,7 @@ deprecations_providers:
     (``backend.target``).
 
     Here is a quick guide for accessing the most common ``BackendConfiguration`` attributes in the 
-    :class:`BackendV2` model::
+    :class:`.BackendV2` model::
 
       BackendV1 model (deprecated) ------------> BackendV2 model
       ----------------------------               ---------------
@@ -25,7 +25,7 @@ deprecations_providers:
       backend.configuration().memory             No representation      
       backend.configuration().max_shots          No representation      
 
-    (*) Note that :attr:`.Backend.target.operation_names` includes ``basis_gates`` and additional 
+    (*) Note that ``Backend.target.operation_names`` includes ``basis_gates`` and additional 
     non-gate instructions, in some implementations it might be necessary to filter the output.
 
     See `this guide <https://docs.quantum.ibm.com/api/qiskit/providers#migrating-from-backendv1-to-backendv2>`__

diff --git a/releasenotes/notes/1.3/deprecate-custom-basis-gates-transpile-e4b5893377f23acb.yaml b/releasenotes/notes/1.3/deprecate-custom-basis-gates-transpile-e4b5893377f23acb.yaml
@@ -2,7 +2,7 @@
 deprecations_transpiler:
   - |
     Providing custom gates through the ``basis_gates`` argument is deprecated 
-    for both :func:`.transpile` and :func:`generate_preset_pass_manager`. This functionality
+    for both :func:`.transpile` and :func:`.generate_preset_pass_manager`. This functionality
     will be removed in Qiskit 2.0. Custom gates are still supported in the :class:`.Target` model,
     and can be provided through the ``target`` argument. One can build a :class:`.Target` instance
     from scratch or use the :meth:`.Target.from_configuration` method with the ``custom_name_mapping`` 

diff --git a/releasenotes/notes/1.3/deprecate-mitigation-f5f6ef3233b3d726.yaml b/releasenotes/notes/1.3/deprecate-mitigation-f5f6ef3233b3d726.yaml
@@ -1,7 +1,7 @@
 ---
 deprecations_misc:
   - |
-    The :mod:`qiskit.result.mitigation` module has been deprecated and will be removed in Qiskit 2.0.
+    The ``qiskit.result.mitigation`` module has been deprecated and will be removed in Qiskit 2.0.
     The deprecation includes the :class:`.LocalReadoutMitigator` and :class:`.CorrelatedReadoutMitigator` classes
     as well as the associated utility functions.
     Their functionality has been superseded by the mthree package, found in https://github.com/Qiskit/qiskit-addon-mthree.
diff --git a/releasenotes/notes/1.3/deprecate-pulse-package-07a621be1db7fa30.yaml b/releasenotes/notes/1.3/deprecate-pulse-package-07a621be1db7fa30.yaml
@@ -34,7 +34,6 @@ deprecations_qpy:
 deprecations_transpiler:
   - |
     As part of the Qiskit Pulse package deprecation, pulse-related aspects in the :class:`qiskit.transpiler.Target` class are being deprecated. These include:
-      * :attr:`~qiskit.transpiler.Target.calibration`
       * :meth:`~qiskit.transpiler.Target.update_from_instruction_schedule_map`
       * :meth:`~qiskit.transpiler.Target.has_calibration`
       * :meth:`~qiskit.transpiler.Target.get_calibration`
@@ -47,16 +46,12 @@ deprecations_transpiler:
       * :class:`~qiskit.transpiler.passes.RZXCalibrationBuilder`
       * :class:`~qiskit.transpiler.passes.EchoRZXWeylDecomposition`
   - |
-    The ``inst_map`` argument in :func:`~qiskit.transpiler.generate_preset_pass_manager`,
-    :meth:`~transpiler.target.Target.from_configuration`, :class:`~qiskit.transpiler.PassManagerConfig` initializer
+    The ``inst_map`` argument in :func:`.generate_preset_pass_manager`,
+    :meth:`~.Target.from_configuration`, :class:`~qiskit.transpiler.PassManagerConfig` initializer
     and :func:`~qiskit.transpiler.preset_passmanagers.common.generate_scheduling` is being deprecated.
   - |
     The ``calibration`` argument in :func:`~qiskit.transpiler.target.InstructionProperties` initializer methods is being
     deprecated.
-deprecations_visualization:
-  - |
-    As part of the Qiskit Pulse package deprecation, pulse drawing via :meth:`qiskit.visualization.pulse_drawer`
-    is being deprecated.
 deprecations_providers:
   - |
     As part of the Qiskit Pulse package deprecation, all pulse-related functionality in :class:`qiskit.providers.BackendV2` class is being deprecated. This includes the following methods:
@@ -72,7 +67,7 @@ deprecations_providers:
     In addition, the ``pulse_channels`` and ``calibrate_instructions`` arguments in the :class:`~qiskit.providers.BackendV2`
     initializer method are being deprecated.
   - |
-    The ``defaults`` argument is being deprecated from the :func:`qiskit.providers.backend_compat.convert_to_target` function.
+    The ``defaults`` argument is being deprecated from the :func:`qiskit.providers.convert_to_target` function.
 deprecations_misc:
   - |
     As part of the Qiskit Pulse package deprecation, the following functions and class are being deprecated as well:

diff --git a/releasenotes/notes/1.3/fix-collect-clifford-83af26d98b8c69e8.yaml b/releasenotes/notes/1.3/fix-collect-clifford-83af26d98b8c69e8.yaml
@@ -1,6 +1,6 @@
 ---
 fixes:
   - |
-    Add more Clifford gates to the :class:`.CollectCliffords()` transpiler pass.
-    In particular, we have added the gates :class:`ECRGate()`, :class:`DCXGate()`,
-    :class:`iSWAPGate()`, :class:`SXGate()` and :class:`SXdgGate()` to this transpiler pass.
+    Add more Clifford gates to the :class:`.CollectCliffords` transpiler pass.
+    In particular, we have added the gates :class:`.ECRGate`, :class:`.DCXGate`,
+    :class:`.iSwapGate`, :class:`.SXGate` and :class:`.SXdgGate` to this transpiler pass.
diff --git a/releasenotes/notes/1.3/fix-v2-pulse-drawer-d05e4e392766909f.yaml b/releasenotes/notes/1.3/fix-v2-pulse-drawer-d05e4e392766909f.yaml
@@ -1,7 +1,7 @@
 ---
 fixes:
   - |
-    Fixed a bug in :func:`qiskit.visualization.pulse_v2.interface.draw` that didn't 
+    Fixed a bug in ``qiskit.visualization.pulse_v2.interface.draw`` that didn't 
     draw pulse schedules when the draw function was called with a :class:`.BackendV2` argument.
     Because the V2 backend doesn't report hardware channel frequencies,
     the generated drawing will show 'no freq.' below each channel label.
diff --git a/releasenotes/notes/1.3/fix_11990-8551c7250207fc76.yaml b/releasenotes/notes/1.3/fix_11990-8551c7250207fc76.yaml
@@ -1,6 +1,6 @@
 ---
 fixes:
   - |
-    Fixes an error when calling the method :meth:`.UnitaryGate.repeat`. 
+    Fixes an error when calling the method :meth:`.Gate.repeat`. 
     Refer to `#11990 <https://github.com/Qiskit/qiskit/issues/11990>`_ for more
     details.
diff --git a/releasenotes/notes/1.3/modernize-circuit-library-6e0be83421fd480b.yaml b/releasenotes/notes/1.3/modernize-circuit-library-6e0be83421fd480b.yaml
@@ -6,7 +6,11 @@ features_circuits:
     constructed using a synthesis method:
 
     * :class:`.GraphState` is represented by :class:`.GraphStateGate`,
-    * :class:`.FourierChecking` can be constructed using :meth:`.fourier_checking`,
-    * :class:`.UnitaryOverlap` can be constructed using :meth:`.unitary_overlap`,
-    * :class:`.HiddenLinearFunction` can be constructed using :meth:`.hidden_linear_function`,
-    * :class:`.PhaseEstimation` can be constructed using :meth:`.phase_estimation`.
+    * :class:`.FourierChecking` can be constructed using 
+      :func:`~qiskit.circuit.library.fourier_checking.fourier_checking`,
+    * :class:`.UnitaryOverlap` can be constructed using 
+      :func:`~qiskit.circuit.library.overlap.unitary_overlap`,
+    * :class:`.HiddenLinearFunction` can be constructed using 
+      :func:`~qiskit.circuit.library.hidden_linear_function.hidden_linear_function`,
+    * :class:`.PhaseEstimation` can be constructed using 
+      :func:`~qiskit.circuit.library.phase_estimation.phase_estimation`.
diff --git a/releasenotes/notes/1.3/optimize-1q-gates-decomposition-ce111961b6782ee0.yaml b/releasenotes/notes/1.3/optimize-1q-gates-decomposition-ce111961b6782ee0.yaml
@@ -1,7 +1,7 @@
 ---
 features_transpiler:
   - |
-    Added a new method :meth:`.DAGCircuit.control_flow_ops` which provides a fast
+    Added a new method :meth:`.DAGCircuit.control_flow_op_nodes` which provides a fast
     path to get all the :class:`.DAGOpNode` in a :class:`.DAGCircuit` that
     contain a :class:`.ControlFlowOp`. This was possible before using the
     :meth:`.DAGCircuit.op_nodes` method and passing the :class:`.ControlFlowOp` class

diff --git a/releasenotes/notes/1.3/oxidize-transpiler-passes-16f2f1c57612e74a.yaml b/releasenotes/notes/1.3/oxidize-transpiler-passes-16f2f1c57612e74a.yaml
@@ -19,7 +19,7 @@ features_transpiler:
     * :class:`.CheckGateDirection`
     * :class:`.RemoveDiagonalGatesBeforeMeasure`
     * :class:`.CheckMap`
-    * :class:`.Split2QUnitaties`
+    * :class:`.Split2QUnitaries`
     * :class:`.FilterOpNodes`
     * :class:`.Depth`
     * :class:`.Size`

diff --git a/releasenotes/notes/1.3/pauli-evo-plugins-612850146c3f7d49.yaml b/releasenotes/notes/1.3/pauli-evo-plugins-612850146c3f7d49.yaml
@@ -78,3 +78,8 @@ upgrade:
     :math:`R_X(-\pi/2)` as basis transformation. Using the :math:`\sqrt{X}` operation,
     represented by the :class:`.SXGate` is more efficient as it uses only a single gate
     implemented as singleton.
+
+    If you were relying on the previous gate usage, we recommend building the circuits with
+    Qiskit 1.2 and exporting them with :func:`.qpy.dump`, or to write a custom
+    :class:`.TransformationPass`, which performs the translation to your desired basis change
+    gate.
diff --git a/releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml b/releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml
@@ -25,12 +25,13 @@ prelude: >
         construction speed. Operations are now distinguished into:
 
         * Structural operations, that have a unique decomposition, and are represented as
-          functions that return a :class:`.QuantumCircuit` (for example: :func:`.real_amplitudes`).
+          functions that return a :class:`.QuantumCircuit` (for example:
+          :func:`~qiskit.circuit.library.real_amplitudes`).
           Most of these functions are built in Rust, resulting in significantly faster circuit
           construction runtime.
 
         * Abstract operations, that can be implemented using different decompositions, are
-          represented as :class:`.Gate` or :class:`qiskit.circuit.Instruction` (for example:
+          represented as :class:`.Gate` or :class:`~qiskit.circuit.Instruction` (for example:
           :class:`.PauliEvolutionGate`). This allows building an abstract quantum circuit
           and letting the compiler choose the optimal decomposition.
 

diff --git a/releasenotes/notes/1.3/rust-consolidation-a791a00380fc78b8.yaml b/releasenotes/notes/1.3/rust-consolidation-a791a00380fc78b8.yaml
@@ -8,6 +8,6 @@ features_transpiler:
     :class:`.ConsolidateBlocks` for :class:`.ConsolidateBlocks` to do
     anything. By doing the collection internally, the overhead from the pass
     is reduced. If :class:`.Collect2qBlocks` or :class:`.Collect1qRuns` are
-    run prior to :class:`.ConsolidateBlocks,` the collected runs by those
+    run prior to :class:`.ConsolidateBlocks`, the collected runs by those
     passes from the property set are used and there is no change in behavior
     for the pass.
diff --git a/releasenotes/notes/1.3/rust-paulifm-1dc7b1c2dc756614.yaml b/releasenotes/notes/1.3/rust-paulifm-1dc7b1c2dc756614.yaml
@@ -5,8 +5,7 @@ features_circuits:
     :func:`~qiskit.circuit.library.zz_feature_map` to construct Pauli feature map circuits. These functions
     are approximately 8x faster than the current circuit library objects,
     :class:`.PauliFeatureMap`, :class:`.ZFeatureMap`, and :class:`.ZZFeatureMap`,
-    and will replace them in the future. Note, that the new functions return a plain
-    :class:`.QuantumCircuit` instead of a :class:`.BlueprintCircuit`.
+    and will replace them in the future. 
 
     The functions can be used as drop-in replacement::