-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add deprecation warning to algs module (#10406)
* Add deprecation warning to algs module * Apply suggestions from code review Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * Add link to repo * Add release note * Add migration guide to release note * Apply suggestions from code review Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
- Loading branch information
1 parent
94cb65e
commit 2616602
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
releasenotes/notes/deprecate-algorithms-7149dee2da586549.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
deprecations: | ||
- | | ||
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 :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 :mod:`qiskit.algorithms` you should update your | ||
requirements to also include ``qiskit-algorithms`` and update the imports | ||
from ``qiskit.algorithms`` to ``qiskit_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 :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. | ||