Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation warning to algs module #10406

Merged
merged 8 commits into from
Jul 20, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions qiskit/algorithms/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@
=====================================
Algorithms (:mod:`qiskit.algorithms`)
=====================================

.. deprecated:: 0.25.0

The :mod:`qiskit.algorithms` module has been migrated to an independent package:
[LINK_PLACEHOLDER].
ElePT marked this conversation as resolved.
Show resolved Hide resolved
The current import path is deprecated and will be removed no earlier
than 3 months after the release date. You can run ``pip install qiskit_algorithms``
and import ``from qiskit_algorithms`` instead.

It contains a collection of quantum algorithms, for use with quantum computers, to
carry out research and investigate how to solve problems in different domains on
near-term quantum devices with short depth circuits.
Expand Down Expand Up @@ -297,6 +306,8 @@
AlgorithmJob

"""
import warnings

from .algorithm_job import AlgorithmJob
from .algorithm_result import AlgorithmResult
from .evolvers import EvolutionResult, EvolutionProblem
Expand Down Expand Up @@ -412,3 +423,13 @@
"VarQTE",
"VarQTEResult",
]

warnings.warn(
"``qiskit.algorithms`` has been migrated to an independent package: "
"[LINK_PLACEHOLDER]."
ElePT marked this conversation as resolved.
Show resolved Hide resolved
"The ``qiskit.algorithms`` import path is deprecated as of qiskit-terra 0.25.0 and"
woodsp-ibm marked this conversation as resolved.
Show resolved Hide resolved
"will be removed no earlier than 3 months after the release date. "
"Please run ``pip install qiskit_algorithms`` and use ``import qiskit_algorithms`` instead.",
category=DeprecationWarning,
stacklevel=2,
)