Skip to content

Commit

Permalink
Revert "Remove references from renos"
Browse files Browse the repository at this point in the history
This reverts commit 6b291ab.
  • Loading branch information
ElePT committed Nov 6, 2023
1 parent 738656b commit 5ccd0ab
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions releasenotes/notes/0.17/prepare-0.17-2ab9429b69e1d25c.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
prelude: |
The Qiskit Terra 0.17.0 includes many new features and bug fixes. The major
new feature for this release is the introduction of the
``qiskit.algorithms`` and :mod:`qiskit.opflow` modules which were
:mod:`qiskit.algorithms` and :mod:`qiskit.opflow` modules which were
migrated and adapted from the :mod:`qiskit.aqua` project.
features:
- |
A new module ``qiskit.algorithms`` has been introduced. This module
A new module :mod:`qiskit.algorithms` has been introduced. This module
contains functionality equivalent to what has previously been
provided by the :mod:`qiskit.aqua.algorithms` module (which is now
deprecated) and provides the building blocks for constructing quantum
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ upgrade:
was done because of the wide use of the
:class:`~qiskit.circuit.library.PhaseOracle` (which depends on
having tweedledum installed) with several algorithms
from ``qiskit.algorithms``.
from :mod:`qiskit.algorithms`.
- |
The optional extra ``full-featured-simulators`` which could previously used
to install ``qiskit-aer`` with something like
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ features:
on backends with measurement errors.
Readout mitigator classes have two main methods:
* :meth:`~.BaseReadoutMitigator.expectation_value` which computes an
mitigated expectation value and standard error of a diagonal operator from
a noisy :class:`~qiskit.result.Counts` object.
Expand All @@ -17,7 +17,7 @@ features:
mitigated :class:`~qiskit.result.QuasiDistribution`, including standard
error, from a noisy counts object.
Note that currently the ``qiskit.algorithms`` module and the
Note that currently the :mod:`qiskit.algorithms` module and the
:class:`~qiskit.utils.QuantumInstance` class still use the legacy mitigators
migrated from Qiskit Ignis in :mod:`qiskit.utils.mitigation`. It is planned
to upgrade the module to use the new mitigator classes and deprecate the legacy
Expand All @@ -26,12 +26,12 @@ features:
Added the :class:`~qiskit.result.LocalReadoutMitigator` class for
performing measurement readout error mitigation of local measurement
errors. Local measuerment errors are those that are described by a
tensor-product of single-qubit measurement errors.
tensor-product of single-qubit measurement errors.
This class can be initialized with a list of :math:`N` single-qubit of
measurement error assignment matrices or from a backend using the readout
error information in the backend properties.
Mitigation is implemented using local assignment-matrix inversion which has
complexity of :math:`O(2^N)` for :math:`N`-qubit mitigation of
:class:`~qiskit.result.QuasiDistribution` and expectation values.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ upgrade:
fixes:
- |
The :class:`~.AmplitudeAmplifier` is now correctly available from the root
``qiskit.algorithms`` module directly. Previously it was not included
:mod:`qiskit.algorithms` module directly. Previously it was not included
in the re-exported classes off the root module and was only accessible
from ``qiskit.algorithms.amplitude_amplifiers``.
Fixed `#7751 <https://github.com/Qiskit/qiskit-terra/pull/7752>`__.
2 changes: 1 addition & 1 deletion releasenotes/notes/0.22/adapt-vqe-0f71234cb6ec92f8.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
features:
- |
Added a new algorithm class, :class:`~.AdaptVQE` to ``qiskit.algorithms``
Added a new algorithm class, :class:`~.AdaptVQE` to :mod:`qiskit.algorithms`
This algorithm uses a :class:`qiskit.algorithms.minimum_eigensolvers.VQE`
in combination with a pool of operators from which to build out an
:class:`qiskit.circuit.library.EvolvedOperatorAnsatz` adaptively.
Expand Down
2 changes: 1 addition & 1 deletion releasenotes/notes/0.22/prepare-0.22-118e15de86d36072.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ prelude: |
Additionally, :class:`~.BackendV2` backends can now optionally set
custom default plugins to use for the scheduling and translation stages.
* Updated algorithm implementations in ``qiskit.algorithms`` that leverage
* Updated algorithm implementations in :mod:`qiskit.algorithms` that leverage
the :mod:`~.primitives` classes that implement the :class:`~.BaseSampler` and
:class:`~.BaseEstimator`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
features:
- |
Added the :class:`~.PVQD` class to the time evolution framework in ``qiskit.algorithms``.
Added the :class:`~.PVQD` class to the time evolution framework in :mod:`qiskit.algorithms`.
This class implements the projected Variational Quantum Dynamics (p-VQD) algorithm
`Barison et al. <https://quantum-journal.org/papers/q-2021-07-28-512/>`_.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ upgrade:
- |
The deprecated modules ``factorizers`` and ``linear_solvers``, containing
``HHL`` and ``Shor`` have been removed from
``qiskit.algorithms``. These functionalities
:mod:`qiskit.algorithms`. These functionalities
were originally deprecated as part of the 0.22.0 release (released on
October 13, 2022). You can access the code through the Qiskit Textbook instead:
`Linear Solvers (HHL) <https://learn.qiskit.org/course/ch-applications/solving-linear-systems-of-equations-using-hhl-and-its-qiskit-implementation>`_ ,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
deprecations:
- |
The ``qiskit.algorithms`` module has been deprecated and will be removed
The :mod:`qiskit.algorithms` module has been deprecated and will be removed
in a future release. It has been superseded by a new standalone library
``qiskit-algorithms`` which can be found on PyPi or on Github here:
https://github.com/qiskit-community/qiskit-algorithms
The ``qiskit.algorithms`` module will continue to work as before and bug fixes
The :mod:`qiskit.algorithms` will continue to work as before and bug fixes
will be made to module until its future removal, but active development
of new features has moved to the new package.
If you're relying on ``qiskit.algorithms`` you should update your
If you're relying on :mod:`qiskit.algorithms` you should update your
requirements to also include ``qiskit-algorithms`` and update the imports
from ``qiskit.algorithms`` to ``qiskit_algorithms``. Please note that this
new package does not include already deprecated algorithms code, including
``opflow`` and ``QuantumInstance``-based algorithms. If you have not yet
migrated from ``QuantumInstance``-based to primitives-based algorithms,
you should follow the migration guidelines in https://qisk.it/algo_migration.
The decision to migrate the ``qiskit.algorithms`` module to a
The decision to migrate the :mod:`~.algorithms` module to a
separate package was made to clarify the purpose Qiskit and
make a distinction between the tools and libraries built on top of it.
Expand Down

0 comments on commit 5ccd0ab

Please sign in to comment.