Replace qiskit.algorithms with qiskit_algorithms #537

t-imamichi · 2023-08-21T06:29:14Z

Summary

Replace qiskit.algorithms with qiskit_algorithms except QAOAClient and VQEClient because they are deprecated.

This PR requires qiskit-algorithms>=0.2.0 to switch to qiskit_algorithms.utils.algorithm_globals.

Details and comments

Since qiskit-algorithms does not support python 3.7, unit tests fail with Python 3.7. I made Drop python 3.7 support #538 to drop Python 3.7 support.
Remove runtime program, quantum instance, and opflow #542

woodsp-ibm · 2023-08-21T15:30:59Z

We should add qiskit_algorithms to the requirements file.
Once 0.2.0 of qiskit_algorithms in released we can also switch here from qiskit.utils import algorithm_globals over to the equivalent class in qiskit_algorithms i.e. from qiskit_algorithms.utils import algorithm_globals and make that the min version in the requirements file. Similar to noted here /Switch to qiskit_algorithms qiskit-finance#291 qiskst_algorithms works with either but that file in utils in Qiskit, along with another that's only used by algorithms. I expect to be deprecated and removed when the algorithms are removed from Qiskit so its better to switch now.

coveralls · 2023-08-22T15:59:03Z

Pull Request Test Coverage Report for Build 5949370263

17 of 17 (100.0%) changed or added relevant lines in 7 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.01%) to 92.427%

Totals
Change from base Build 5947076830:	0.01%
Covered Lines:	4455
Relevant Lines:	4820

💛 - Coveralls

t-imamichi · 2023-08-23T02:33:59Z

Yes, I added qiskit-algorithms in requirements.txt.

OK. I will switch to from qiskit_algorithms.utils import algorithm_globals. When is qiskit-algorithms 0.2.0 planned? Is it soon?

woodsp-ibm · 2023-08-23T03:20:01Z

When is qiskit-algorithms 0.2.0 planned? Is it soon?

Should be very soon now.

t-imamichi · 2023-08-29T07:08:53Z

It's ready to review because qiskit-algorithms 0.2.0 was released on Aug 24.

woodsp-ibm · 2023-08-29T11:50:53Z

@t-imamichi My take is that I think the logic ought to be able to take a qiskit.algorithms instance or a qiskit_algorithms one. The instance checks there I think will prevent the former. That may end up being a tradeoff in what sort of upfront checks can be made and how much we want to switch to just using qiskit_algorithms and no longer refer to qiskit.algorithms at this point. Did you see the post in the thread in the internal algorithms related discussion channel - where you mentioned this PR it was a response to that - it includes some thoughts about this and more.

t-imamichi · 2023-08-30T14:01:31Z

@woodsp-ibm Thanks. I tried to remove all imports of qiskit.algorithms 63474dc. It would work fine with qiskit.algorithms implicitly. But, it requires #542 to pass the unit tests because some legacy tests uses qiskit.algorithms that need to be removed first.

README.md

# Conflicts: # docs/tutorials/02_converters_for_quadratic_programs.ipynb # qiskit_optimization/algorithms/grover_optimizer.py # qiskit_optimization/algorithms/minimum_eigen_optimizer.py # qiskit_optimization/algorithms/warm_start_qaoa_optimizer.py # requirements.txt # test/algorithms/test_grover_optimizer.py # test/algorithms/test_min_eigen_optimizer.py

t-imamichi · 2023-09-01T09:15:00Z

qiskit_optimization/algorithms/minimum_eigen_optimizer.py

+            if not hasattr(eigen_result, "eigenstate"):
+                raise QiskitOptimizationError(
+                    "MinimumEigenOptimizer does not support this minimum eigensolver "
+                    f"{type(self._min_eigen_solver)}. "
+                    "You can use qiskit_algorithms.SamplingMinimumEigensolver instead."
+                )


Instead of early type check of SamplingMinimumEigensolver or NumPyMinimumEigensolver, I added a result check when solve is invoked.

It will certainly result in a more friendly error message that is easier to understand. This is of course detected though after its run compute_minimum_eigenvalue which may take a lot of time/resources that ends up being wasted. An IDE via the typehinting should flag VQE (which I think we we most concerned about in 0.5 since in the past you could use this) as not being valid to be used for this algorithm. I think its ok - we can see how it goes - one suggestion I had made was to get the class name string from the solver instance and compare that up front to see if it was one of the primitive based VQE's we know about ie - that being just a string check does not require anything to be imported. But we could always add this later if users are still tripping up on VQE - since 0.5 has been out a while hopefully users are familiar enough now. And its quite clear now in the docs what is supported...

woodsp-ibm · 2023-09-01T14:26:07Z

qiskit_optimization/__init__.py

 `Grover Adaptive Search <https://arxiv.org/abs/quant-ph/9607014>`_
 (:class:`~algorithms.GroverOptimizer`), leveraging
-fundamental :mod:`~qiskit.algorithms.minimum_eigensolver` provided by Qiskit Terra.
+fundamental :mod:`~qiskit_algorithms.minimum_eigensolvers` provided by


With qiskit_algorithms this will not form a link as it will not resolve to any documentation since the minimum_eigensolvers module is not documented as it was before (before it was not a link either since it lacked the s at the end). I think its ok.

The Qiskit Algorithms link on the next line I think would be better to the published docs though so you go from docs to docs ie. use https://qiskit.org/ecosystem/algorithms/

And for the module above if you preferred it to be a link then it could be changed to make it a link to where the Minimum Eigensolvers are documented ie this https://qiskit.org/ecosystem/algorithms/apidocs/qiskit_algorithms.html#minimum-eigensolvers

Thanks. I updated it to mention minimum eigensolvers with https://qiskit.org/ecosystem/algorithms/apidocs/qiskit_algorithms.html#minimum-eigensolvers instead of ~qiskit_algorithms.minimum_eigensolvers

Thx, you did not push the change yet then?

Sorry. I forgot to push it. 10d057b

woodsp-ibm · 2023-09-01T14:43:54Z

releasenotes/notes/switch-to-qiskit-algorithms-b0af38fe547bf5b5.yaml

+prelude: >
+    Qiskit Optimization 0.6 switches from ``qiskit.algorithms`` of Qiskit Terra
+    to `Qiskit Algorithms <https://github.com/qiskit-community/qiskit-algorithms>`_.
+    Qiskit Optimization 0.6 drops supports of the former algorithms based on


Although support for the qiskit.algorithms primitive based ones is dropped, for the moment since they are compatible with what was migrated to qiskit_algorithms they should still work so any users code should still work as they transition/upgrade it - right.

I'm wondering whether I have to mention qiskit.algorithms is not officially supported by qiskit-optimization but it works actually.

The intent was really to have it work so users had a easier transition. Code that they had working based on primitives should still work with this new version. Then they can simply switch the code to qiskit_algorithms and it should work just like before.

woodsp-ibm · 2023-09-01T14:48:49Z

test/algorithms/test_grover_optimizer.py

@@ -40,6 +41,7 @@
 class TestGroverOptimizer(QiskitOptimizationTestCase):
    """GroverOptimizer tests."""

+    @unittest.skipUnless(optionals.HAS_AER, "qiskit-aer is required to run this test")


At some point, since the reference Sampler is probably fast enough, we could probably change tests like these so we do not require Aer any longer and this test no longer is an optional one - though CI of course will install Aer. I would leave things as they are now. Its more just a comment.

Sorry that I removed this line accidentally in #542. I intended to revert the removal in this PR. It requires aer sampler because terra sampler takes much more time than aer sampler (#451 for details).

svdbtno · 2023-09-12T11:39:47Z

@t-imamichi When can we expect this to be released?

t-imamichi requested review from stefan-woerner and woodsp-ibm as code owners August 21, 2023 06:29

replace qiskit.algorithms with qiskit_algorithms

c8952b5

t-imamichi force-pushed the qiskit_alg branch from 9a1d9bc to c8952b5 Compare August 21, 2023 06:32

t-imamichi mentioned this pull request Aug 21, 2023

Drop python 3.7 support #538

Merged

t-imamichi added 2 commits August 21, 2023 16:22

update readme and tutorials

988cd46

update readme and tutorials

5f0a6a9

Merge branch 'main' into qiskit_alg

6c5197f

t-imamichi and others added 3 commits August 23, 2023 17:23

switch to qiskit_algorithms.utils.algorithm_globals

258fef9

Merge branch 'main' into qiskit_alg

f2d4d42

fix copyright year

aadd103

remove all qiskit.algorithms import

63474dc

woodsp-ibm reviewed Aug 30, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

use short imports

dea08d3

t-imamichi mentioned this pull request Aug 31, 2023

Remove runtime program, quantum instance, and opflow #542

Merged

5 tasks

woodsp-ibm mentioned this pull request Aug 31, 2023

Switch from qiskit-terra to qiskit #543

Merged

t-imamichi added 3 commits September 1, 2023 12:09

add vqe type check

c1d996d

add reno

1cd4d87

t-imamichi commented Sep 1, 2023

View reviewed changes

woodsp-ibm reviewed Sep 1, 2023

View reviewed changes

woodsp-ibm mentioned this pull request Sep 1, 2023

Integrate QRAO into Qiskit Optimization #487

Merged

8 tasks

t-imamichi added 2 commits September 4, 2023 17:09

update qiskit alg links

10d057b

add spell dict

1418093

t-imamichi force-pushed the qiskit_alg branch from 6ec2a94 to 1418093 Compare September 4, 2023 14:56

woodsp-ibm approved these changes Sep 4, 2023

View reviewed changes

t-imamichi added the automerge label Sep 5, 2023

Merge branch 'main' into qiskit_alg

e0a8b41

mergify bot merged commit 80e7ef7 into qiskit-community:main Sep 5, 2023
15 checks passed

t-imamichi deleted the qiskit_alg branch September 5, 2023 01:51

woodsp-ibm mentioned this pull request Sep 5, 2023

Switch to qiskit_algorithms qiskit-community/qiskit-finance#291

Merged

4 tasks

t-imamichi mentioned this pull request Sep 8, 2023

qiskit_algorithms namespace is not supported. #535

Closed

svdbtno mentioned this pull request Sep 28, 2023

Question: When will a new release be made? #561

Closed

airwoodix mentioned this pull request Nov 13, 2023

Use qiskit_algorithms instead of deprecated qiskit.algorithms qiskit-community/qiskit-aqt-provider#110

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace qiskit.algorithms with qiskit_algorithms #537

Replace qiskit.algorithms with qiskit_algorithms #537

t-imamichi commented Aug 21, 2023 •

edited

Loading

woodsp-ibm commented Aug 21, 2023

coveralls commented Aug 22, 2023 •

edited

Loading

t-imamichi commented Aug 23, 2023

woodsp-ibm commented Aug 23, 2023

t-imamichi commented Aug 29, 2023

woodsp-ibm commented Aug 29, 2023

t-imamichi commented Aug 30, 2023

t-imamichi Sep 1, 2023

woodsp-ibm Sep 1, 2023

woodsp-ibm Sep 1, 2023

t-imamichi Sep 4, 2023

woodsp-ibm Sep 4, 2023

t-imamichi Sep 4, 2023

woodsp-ibm Sep 1, 2023

t-imamichi Sep 4, 2023

woodsp-ibm Sep 4, 2023

woodsp-ibm Sep 1, 2023

t-imamichi Sep 4, 2023

svdbtno commented Sep 12, 2023

Replace qiskit.algorithms with qiskit_algorithms #537

Replace qiskit.algorithms with qiskit_algorithms #537

Conversation

t-imamichi commented Aug 21, 2023 • edited Loading

Summary

Details and comments

woodsp-ibm commented Aug 21, 2023

coveralls commented Aug 22, 2023 • edited Loading

Pull Request Test Coverage Report for Build 5949370263

💛 - Coveralls

t-imamichi commented Aug 23, 2023

woodsp-ibm commented Aug 23, 2023

t-imamichi commented Aug 29, 2023

woodsp-ibm commented Aug 29, 2023

t-imamichi commented Aug 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svdbtno commented Sep 12, 2023

t-imamichi commented Aug 21, 2023 •

edited

Loading

coveralls commented Aug 22, 2023 •

edited

Loading