Skip to content

Commit

Permalink
Prepare 1.0 typos - part 2 (#21)
Browse files Browse the repository at this point in the history
* InverseModifier

* add-commutation-library

* Update add-commutation-library-88b7ff65b3d35f9a.yaml

* add-commutation-library

* .

* .

* .

* .

* Use iso8601 for dates

---------

Co-authored-by: Matthew Treinish <[email protected]>
  • Loading branch information
1ucian0 and mtreinish committed Feb 15, 2024
1 parent 0d5629e commit 88dbc00
Show file tree
Hide file tree
Showing 26 changed files with 80 additions and 68 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
upgrade:
- |
The property ``IntegerComparator.num_ancilla_qubits`` is removed, which was
deprecated in Qiskit 0.23 (released on Oct 2020). Its functionality is fully covered
The property ``IntegerComparator.num_ancilla_qubits`` is removed, which was
deprecated in Qiskit 0.23 (released in 2020-10). Its functionality is fully covered
by :attr:`.IntegerComparator.num_ancilla`.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ upgrade:
Now this conversion function adds delay instruction and removes faulty instructions by default.
fixes:
- |
Fixes return of improper measurement schedule that may occur in the following program
Fixes return of improper measurement schedule that may occur in the following program:
.. code-block:: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ features:
Added a new keyword argument, ``label``, to the constructor on the
:class:`.BarrierBeforeFinalMeasurements` transpiler pass. If specified the
inserted barrier will be assigned the specified label. This also prevents
the inserted barrier from being merged with any any other pre-existing
the inserted barrier from being merged with any other pre-existing
adjacent barriers.
other:
- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ features:
The constructor of :class:`.OptimizeAnnotated` pass accepts optional
arguments ``target``, ``equivalence_library``, ``basis_gates`` and ``recurse``.
When ``recurse`` is ``True`` (the default value) and when either ``target``
or ``basis_gates`` are specified, the pass recursively descends into the gates
or ``basis_gates`` are specified, the pass recursively descends into the gate's
``definition`` circuits, with the exception of gates that are already supported
by the target or that belong to the equivalence library. On the other hand, when
neither ``target`` nor ``basis_gates`` are specified,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ deprecations:
- |
Deprecates the :class:`~.BaseEstimator` ``_circuits``, ``_observables``
and ``_parameters``, and :class:`~.BaseSampler` ``_circuits`` and
``_parameters`` attributes set during `__init__`. Any subclasses
``_parameters`` attributes set during ``__init__``. Any subclasses
relying on these methods should now manually initialize them to avoid
deprecation warnings.
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ deprecations:
will be removed in a future release. The following objects have been moved to
:mod:`qiskit.synthesis`:
* :class:`~.OneQubitEulerDecomposer` has been moved to :mod:`qiskit.synthesis.one_qubit`
* :class:`~.TwoQubitBasisDecomposer` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :class:`~.XXDecomposer` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :func:`~.two_qubit_cnot_decompose` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :func:`~.qs_decomposition` has been moved to :mod:`qiskit.synthesis.unitary`
* :class:`~.OneQubitEulerDecomposer` has been moved to :mod:`qiskit.synthesis.one_qubit`
* :class:`~.TwoQubitBasisDecomposer` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :class:`~.XXDecomposer` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :func:`~.two_qubit_cnot_decompose` has been moved to :mod:`qiskit.synthesis.two_qubits`
* :func:`~.qs_decomposition` has been moved to :mod:`qiskit.synthesis.unitary`
The class :class:`.Quaternion` has been migrated from :mod:`qiskit.quantum_info.synthesis` to
:mod:`qiskit.quantum_info`. This move has not affected the usual import path of the class.
This function is deprecated and will be removed in a next release:
* :func:`~.cnot_rxx_decompose`
* :func:`~.cnot_rxx_decompose`
upgrade:
- |
These functions were removed, since they have already been deprecated in a previous release:
* ``decompose_clifford`` (use :func:`.qiskit.synthesis.synth_clifford_full` instead)
* ``decompose_cnotdihedral`` (use :func:`.qiskit.synthesis.synth_cnotdihedral_full` instead)
* ``decompose_clifford`` (use :func:`.qiskit.synthesis.synth_clifford_full` instead)
* ``decompose_cnotdihedral`` (use :func:`.qiskit.synthesis.synth_cnotdihedral_full` instead)
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
features:
- |
:meth:`.SparsePauliOp.from_operator` now uses an implementation of the
"tensorized Pauli decomposition algorithm" presented in
Hatznko, Binkowski and Gupta (2023) <https://arxiv.org/abs/2310.13421>`__. The method is now
"tensorized Pauli decomposition algorithm" presented in
`Hatznko, Binkowski and Gupta (2023) <https://arxiv.org/abs/2310.13421>`__. The method is now
several orders of magnitude faster; for example, it is possible to decompose a random
10-qubit operator in around 250ms on a consumer Macbook Pro (Intel i7, 2020).
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ fixes:
The use of the (deprecated) ``Optimizer`` class on :class:`~.AQC` did not have a
non-deprecated alternative path, which should have been introduced in
the original ``qiskit-algorithms`` deprecation PR
[#10406](https://github.com/Qiskit/qiskit/pull/10406).
`#10406 <https://github.com/Qiskit/qiskit/pull/10406>`_.
It now accepts a callable that implements the :class:`~.Minimizer` protocol,
as explicitly stated in the deprecation warning. The callable can look like the
following example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
fixes:
- |
Calling :meth:`~.QuantumCircuit.copy` or :meth:`~.QuantumCircuit.copy_empty_like` on a
:class:¬.BlueprintCircuit` will now correctly propagate the
:class:`.BlueprintCircuit` will now correctly propagate the
:attr:`~.QuantumCircuit.global_phase` to the copy. Previously, the global phase would always be zero after the copy.
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ fixes:
version that is not supported by this version of Qiskit it will now display
a descriptive error message. Previously, it would raise an internal error
because of the incompatibility between the formats which was difficult to
debug. If the QPY format verison is not supported that indicates the Qiskit
debug. If the QPY format version is not supported that indicates the Qiskit
version will need to be upgraded to read the QPY payload.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ fixes:
- |
Fixed an issue when using :func:`.transpile` or running a preset pass
manager (such as generated by :func:`.generate_preset_pass_manager`) when
targetting a backend that has disjoint connectivity adding extra barriers
targeting a backend that has disjoint connectivity adding extra barriers
to the output :class:`.QuantumCircuit`. In some cases several
single qubit :class:`.Barrier` directives would be included in the output
circuit right before any final measurements in the circuit. This was
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
fixes:
- |
Fixed an issue with the :class:`~.OptimizeSwapBeforeMeasure` pass where
it would incorrectly optimize circuits involving swap and measure
instructions. This commit fixes the bug by changing `DAGCircuit.successors`
to `DAGCircuit.descendants`. Also, added a couple of extra tests to ensure
it would incorrectly optimize circuits involving swap and measure
instructions. This commit fixes the bug by changing ``DAGCircuit.successors``
to ``DAGCircuit.descendants``. Also, added a couple of extra tests to ensure
that the bug is fixed. For example::
from qiskit import QuantumCircuit
Expand All @@ -16,7 +16,7 @@ fixes:
qc.measure(0, 0)
print(qc.draw())
print(pass_(qc).draw())
would previously print::
┌─┐┌─┐
Expand All @@ -33,12 +33,12 @@ fixes:
║ └╥┘
c: 1/═╩══╩═
0 0
and now the second ciruit is correctly optimized to::
and now the second circuit is correctly optimized to::
q_0: ──────
┌─┐┌─┐
q_1: ┤M├┤M├
└╥┘└╥┘
c: 1/═╩══╩═
0 0
0 0
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
fixes:
- |
Fixed an issue with the :class:`~.InverseCancellation` pass where it would
incorrectly cancel gates passed in as self inverses with a parameter
incorrectly cancel gates passed in as self-inverses with a parameter
value, if a run of gates had a different parameter value. For example::
from math import pi
Expand Down
4 changes: 2 additions & 2 deletions releasenotes/notes/1.0/fix_11143-d32a262538873a9d.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
upgrade:
- |
The functions ``qiskit.visualization.state_visualization.num_to_latex_ket`` and ``qiskit.visualization.state_visualization.numbers_to_latex_terms``
have been removed, as they were removed in Qiskit 0.40 (released in Jan 2023). For similar functionality, see sympy's ``nsimplify`` and ``latex`` functions.
The functions ``qiskit.visualization.state_visualization.num_to_latex_ket`` and ``qiskit.visualization.state_visualization.numbers_to_latex_terms``
have been removed, as they were removed in Qiskit 0.40 (released in 2023-01). For similar functionality, see Sympy's ``nsimplify`` and ``latex`` functions.
4 changes: 2 additions & 2 deletions releasenotes/notes/1.0/fix_backend_name-e84661707058b529.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ fixes:
- |
Fixed an issue in the :class:`.QuantumInstance` class where it was assuming
all ``AerSimulator`` backends were always :class:`.BackendV1`. This would cause
combatibility issues with the 0.13.0 release of ``qiskit-aer`` which is starting to
use :class:`.BackendV2` for `AerSimulator`` backends.
compatibility issues with the 0.13.0 release of ``qiskit-aer`` which is starting to
use :class:`.BackendV2` for ``AerSimulator`` backends.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
features:
- |
A new method :meth:`.ParameterExpression.numeric` is added, which converts a fully bound
parameter expression into the most restrictive builtin Python numeric type that accurately
parameter expression into the most restrictive built-in Python numeric type that accurately
describes the result of the symbolic evaluation. For example, a symbolic integer will become an
:class:`int`, while a symbolic real number will become a :class:`float` and a complex number
will become a :class:`complex`. This method includes several workarounds for peculiarities of
Expand Down
6 changes: 3 additions & 3 deletions releasenotes/notes/1.0/platform-support-f7f693aaf5dec044.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ upgrade:
to debug an issue. Requiring ``symengine`` for all systems greatly decreases
the complexity and optimizes Qiskit for higher performance. However,
users on i686 Linux, 32 bit Windows, and s390x Linux (the platforms without
precompiled packages on PyPI) will need to build symengine from source.
precompiled packages on PyPI) will need to build Symengine from source.
- |
Support for 32 bit platforms, i686 Linux and 32 bit Windows, on
Python < 3.10 has been downgraded from Tier 2 to Tier 3, as documented in
the `platform support page <https://docs.quantum.ibm.com/start/install#operating-system-support>`_. This is a consequence of making
``symengine`` required for all users, as there is a lack of pre-compiled packages
available for these platforms, so users will need to build symengine from
``symengine`` required for all users, as there is a lack of pre-compiled packages
available for these platforms, so users will need to build Symengine from
source.
- |
For macOS users, the minimum version of macOS is now 10.12. Previously, the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,29 @@ upgrade:
has been removed following it deprecation on the 0.46 release. Its
functionality has been replaced by the :mod:`qiskit.quantum_info`
module and the new :mod:`qiskit.providers.basic_provider` module.
The migration from using ``qiskit.providers.basicaer`` (``qiskit.BasicAer``)
to :mod:`qiskit.providers.basic_provider` can be performed as follows::
Migrate from | Replace with
------------------------------------------------------------------------------
``qiskit.BasicAer`` | # The new provider doesn't have a global instance,
| # imports should be from qiskit.providers.basic_provider
``qiskit.providers.basicaer`` | :mod:`.basic_provider`
``BasicAerProvider`` | :class:`.BasicProvider`
``BasicAerJob`` | :class:`.BasicProviderJob`
``QasmSimulatorPy`` | :class:`.BasicSimulator`
``UnitarySimulatorPy`` | use :class:`~.quantum_info.Operator`
``StatevectorSimulatorPy`` | use :class:`~.quantum_info.Statevector`
.. list-table:: BasicAer equivalences
:header-rows: 1
* - Migrate from
- Replace with
* - ``qiskit.BasicAer``
- The new provider doesn't have a global instance, imports should be from ``qiskit.providers.basic_provider``
* - ``qiskit.providers.basicaer``
- :mod:`.basic_provider`
* - ``BasicAerProvider``
- :class:`.BasicProvider`
* - ``BasicAerJob``
- :class:`.BasicProviderJob`
* - ``QasmSimulatorPy``
- :class:`.BasicSimulator`
* - ``UnitarySimulatorPy``
- use :class:`~.quantum_info.Operator`
* - ``StatevectorSimulatorPy``
- use :class:`~.quantum_info.Statevector`
A notable difference is that the new provider is no longer exposed through a global instance
(like ``BasicAer``), so it will not be valid to do ``from qiskit import BasicProvider``.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ upgrade:
0.46. You should instead import from ``qiskit_aer``, which is a drop-in replacement.
- |
Pulse jobs are no longer supported in fake backends, following the deprecation and removal
of the underlying simulation functionality in Qiskit Aer. For pulse-level simulation, outside
of the underlying simulation functionality in Aer. For pulse-level simulation, outside
the context of circuit objects, consider using a special-purpose library such as
`Qiskit Dynamics <https://qiskit.org/ecosystem/dynamics/>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
upgrade:
- |
The module ``ParametricPulse`` is removed.
All classes in it were deprecated since Qiskit 0.39 (with qiskit-terra 0.22), released on Oct 2022.
Instead, use :class:`.SymbolicPulse` and check its documentation for details.
All classes in it were deprecated since Qiskit 0.39 (with qiskit-terra 0.22), released in 2022-10.
Instead, use :class:`.SymbolicPulse` and check its documentation for details.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
upgrade:
- |
Removes the deprecated ``Unroller`` class in :mod:`qiskit.transpiler.passes.basis`.
This class was deprecated in Qiskit Terra 0.45 and has been replaced by
This class was deprecated in Qiskit Terra 0.45 and has been replaced by
the combination usage of :class:`.BasisTranslator` and :class:`.UnrollCustomDefinitions`.
Note that :class:`.BasisTranslator` and :class:`.UnrollCustomDefinitions` take different
arguments than ``Unroller``, as they requires a `EquivalenceLibrary` object to be passed in.
Note that :class:`.BasisTranslator` and :class:`.UnrollCustomDefinitions` take different
arguments than ``Unroller``, as they requires a ``EquivalenceLibrary`` object to be passed in.
Where previously ``Unroller(basis_gates)`` could be used,
you can now use::
.. code-block:: python
from qiskit.circuit.library.standard_gates.equivalence_library import (
StandardEquivalenceLibrary as std_eqlib,
)
Expand All @@ -19,4 +21,3 @@ upgrade:
BasisTranslator(std_eqlib, basis_gates),
])
translated = pm.run(circuit)
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ upgrade:
The following objects have been removed:
* ``SingleQubitUnitary`` (instead use :class:`.library.UnitaryGate`),
* ``Snapshot`` (superseded by Qiskit Aer's save instructions),
* ``Snapshot`` (superseded by Aer's save instructions),
* ``ExtensionError``,
along with the following circuit methods::
along with the following circuit methods:
* ``QuantumCircuit.snapshot``,
* ``QuantumCircuit.squ``,
Expand All @@ -36,7 +36,7 @@ upgrade:
* ``QuantumCircuit.ucrz``.
These operations can still be performed by appending the appropriate
instruction to a quantum circuit.
instruction to a quantum circuit.
- |
Removed deprecated, duplicated :class:`.QuantumCircuit` methods. These include
Expand Down
4 changes: 2 additions & 2 deletions releasenotes/notes/1.0/remove-ibmq-4bb57a04991da9af.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ upgrade:
for more details.
- |
Removed the deprecated module ``qiskit.tools.jupyter`` which previously
included jupyter magics and widgets for interactively visualizing some data
included Jupyter Magics and widgets for interactively visualizing some data
from Qiskit. This module was deprecated in Qiskit 0.46.0. Most of this
functionality was directly tied to the legacy ``qiskit-ibmq-provider``
package and was no longer valid so the module was removed. Similar
functionality is available from the ``qiskit_ibm_provider.jupyter`` module
in the `qiskit-ibm-provider <https://github.com/Qiskit/qiskit-ibm-provider>__` package.
in the ` ``qiskit-ibm-provider`` <https://github.com/Qiskit/qiskit-ibm-provider>_` package.
- |
Removed the deprecated module ``qiskit.tools.monitor`` which previously
included tools for tracking :class:`.JobV1` job instances, primarily from
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
upgrade:
- |
It is no longer allowed to pass a :class:`~qiskit.qobj.QasmQobj` as the first input to
The :meth:`~qiskit.providers.basicaer.UnitarySimulatorPy.run`. This functionality was
The :meth:`~qiskit.providers.basicaer.UnitarySimulatorPy.run`. This functionality was
deprecated in Qiskit 0.46 and has now been removed.
Example usage:
.. code-block:: python
from qiskit import transpile, QuantumCircuit
from qiskit.providers.basicaer import BasicAer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ upgrade:
- |
Validation of :class:`qiskit.pulse.SymbolicPulse` objects can now be disabled. By setting
the class attribute :attr:`qiskit.pulse.SymbolicPulse.disable_validation` to ``False``
the method :meth:`validate_parameters` will not be triggered for all `SymbolicPulse` objects.
the method :meth:`validate_parameters` will not be triggered for all ``SymbolicPulse`` objects.
The automatic validation hindered JAX compatibility of the symbolic pulse library, and this
upgrade will make it easier to use Qiskit Pulse with JAX. Moreover, the parameter validation will also be
deactivated when using the :meth:`qiskit.pulse.Schedule.assign_parameters` and
:meth:`qiskit.pulse.ScheduleBlock.assign_parameters` methods. This constitutes a first
step towards a more general parameter validation mechanism, which will be implemented in the future to enable
JAX compatibility of the `ParameterExpression` class, such that parametrized schedules can be generated within a
JAX compatibility of the ``ParameterExpression`` class, such that parametrized schedules can be generated within a
JAX framework.
Note that all library pulses automatically called :meth:`validate_parameters`. However, as part
of the upgrade the call was moved directly to the initialization process of
:class:`qiskit.pulse.SymbolicPulse`. While this doesn't change the behaviour of library pulses,
:class:`qiskit.pulse.SymbolicPulse`. While this doesn't change the behavior of library pulses,
custom symbolic pulses which did not call :meth:`validate_parameters` will now trigger the
method. The new class attribute will allow to easily disable this.
Loading

0 comments on commit 88dbc00

Please sign in to comment.