Remove deprecated methods and args in Primitives #9480

ikkoham · 2023-01-30T10:32:00Z

Summary

Remove methods and args in primitives deprecated from Terra 0.22.

Details and comments

qiskit-bot · 2023-01-30T10:32:09Z

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

coveralls · 2023-01-30T11:07:23Z

Pull Request Test Coverage Report for Build 4674756685

30 of 32 (93.75%) changed or added relevant lines in 7 files are covered.
2289 unchanged lines in 172 files lost coverage.
Overall coverage increased (+0.05%) to 85.413%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/primitives/base/base_estimator.py	7	8	87.5%
qiskit/primitives/base/base_sampler.py	5	6	83.33%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/dense_layout.rs	1	95.3%
qiskit/algorithms/eigen_solvers/eigen_solver.py	1	97.78%
qiskit/algorithms/evolvers/real_evolver.py	1	92.31%
qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py	1	96.43%
qiskit/algorithms/phase_estimators/phase_estimation_result.py	1	96.36%
qiskit/algorithms/time_evolvers/variational/solvers/ode/abstract_ode_function.py	1	93.33%
qiskit/algorithms/time_evolvers/variational/var_qite.py	1	94.74%
qiskit/circuit/add_control.py	1	97.2%
qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py	1	98.55%
qiskit/circuit/library/standard_gates/p.py	1	98.9%

Totals
Change from base Build 4379887393:	0.05%
Covered Lines:	67544
Relevant Lines:	79079

💛 - Coveralls

`BaseSampler` and `BaseEstimator` in terra deprecated circuits, observables and parameters as arguments for their constructors. They will be reduced in the next release of terra (0.24). Because it took three months since terra started warning of deprecation for these arguments, Aer reduces them from their arguments before terra's PR (Qiskit/qiskit#9480) is released. * Remove deprecated methods and args in Primitives * add reno Co-authored-by: Hiroshi Horii <[email protected]>

qiskit/primitives/base/base_sampler.py

woodsp-ibm · 2023-03-10T15:12:39Z

qiskit/primitives/base/base_estimator.py

@@ -239,8 +189,7 @@ def run(
            **run_opts.__dict__,
        )

-    # This will be comment out after 0.22. (This is necessary for the compatibility.)
-    # @abstractmethod
+    @abstractmethod


I am not sure if you want to do anything about the raise in the body here (same in base_sampler) - python now will not let you instantiate any class without it implemented right so the only time you might see this is looking in this source code if some subclass you created was failing and you had not dealt with the deprecation yet. So if its more documenting that this was changed to abstract that did not (will not) happen until 0.24 right - not 0.22.

I am late in removing my comment because of the delay in updating the other libraries. Well, 0.24 would also be after 0.22.

Seems like we need to at least update the error message in the NotImplementedError here, correct? It mentions 0.22.

This method can still be called by a concrete subclass, so IMO we should still raise NotImplementedError with a more suitable message.

t-imamichi · 2023-03-22T10:01:44Z

qiskit/primitives/base/base_estimator.py

        super().__init__(options)

-    ################################################################################


I don't think this removal is related to this deprecation. I'm not a fan of this type of comment to indicate sections, but we need to discuss the removal carefully.

Yeah. This is my bad. This was mistakenly approved during the review at the time of introduction.
Let's discuss here.

Is there more discussion needed here? Personally, it seems like the section headings are less useful now that many of the things under Deprecations have been removed.

kevinhartman

Hi @ikkoham! Looks good so far.

If you have time, please address these comments so we can get this merged before the upcoming release.

qiskit/primitives/base/base_estimator.py

kevinhartman · 2023-04-11T20:25:40Z

qiskit/primitives/base/base_estimator.py

        super().__init__(options)

-    ################################################################################


Is there more discussion needed here? Personally, it seems like the section headings are less useful now that many of the things under Deprecations have been removed.

kevinhartman · 2023-04-11T20:33:34Z

qiskit/primitives/base/base_estimator.py

@@ -239,8 +189,7 @@ def run(
            **run_opts.__dict__,
        )

-    # This will be comment out after 0.22. (This is necessary for the compatibility.)
-    # @abstractmethod
+    @abstractmethod


Seems like we need to at least update the error message in the NotImplementedError here, correct? It mentions 0.22.

This method can still be called by a concrete subclass, so IMO we should still raise NotImplementedError with a more suitable message.

qiskit/primitives/base/base_sampler.py

releasenotes/notes/delete-args-and-methods-in-primitives-d89d444ec0217ae6.yaml

kevinhartman · 2023-04-11T21:01:13Z

test/python/primitives/test_estimator.py

@@ -58,358 +58,6 @@ def setUp(self):
            [1, 2, 3, 4, 5, 6],
        )

-    def test_estimator(self):


Just to double check, is there anything we're removing here that should be ported to use whatever the proper new code paths are? In other words, are we inadvertently reducing code coverage?

Thank you. I checked all tests. I readded three tests: test_run_with_operator and test_run_with_shots_option_none for Estimator and test_run_reverse_meas_order for Sampler.

I removed duplicated tests.

We don't test e2e test for PauliSumOp, instead we added the conversion test (test_validate_observables).

No tests corresponding to test_estimator_param_reverse since we do not have this feature (Passing parameters, not parameter_values).

ikkoham

@kevinhartman Thank you very much for your review. I improved the code now. Could you check again, please?

qiskit/primitives/base/base_estimator.py

ikkoham · 2023-04-12T04:45:12Z

test/python/primitives/test_estimator.py

@@ -58,358 +58,6 @@ def setUp(self):
            [1, 2, 3, 4, 5, 6],
        )

-    def test_estimator(self):


Thank you. I checked all tests. I readded three tests: test_run_with_operator and test_run_with_shots_option_none for Estimator and test_run_reverse_meas_order for Sampler.

I removed duplicated tests.

We don't test e2e test for PauliSumOp, instead we added the conversion test (test_validate_observables).

No tests corresponding to test_estimator_param_reverse since we do not have this feature (Passing parameters, not parameter_values).

ikkoham · 2023-04-12T05:07:49Z

I added the label priority: high since this blocks development of other primitives.

t-imamichi

LGTM

kevinhartman

Thanks for the updates!

LGTM

* Remove deprecated methods and args in Primitives * rm unnecessary comments * add reno * Update qiskit/primitives/base/base_sampler.py * From review comments

Remove deprecated methods and args in Primitives

d924d0c

ikkoham added Changelog: Removal Include in the Removed section of the changelog mod: primitives Related to the Primitives module labels Jan 30, 2023

ikkoham added this to the 0.24.0 milestone Jan 30, 2023

ikkoham requested review from a team, t-imamichi, manoelmarques, woodsp-ibm and ElePT as code owners January 30, 2023 10:32

ikkoham added 2 commits January 30, 2023 19:37

rm unnecessary comments

5650a61

add reno

bb265e5

ikkoham marked this pull request as draft January 30, 2023 10:51

ikkoham mentioned this pull request Jan 30, 2023

Remove deprecated methods and args in Primitives Qiskit/qiskit-aer#1711

Merged

ikkoham added 2 commits February 1, 2023 11:23

Merge branch 'main' into primitives/rm-in-primitives

0762fd3

Merge branch 'main' into primitives/rm-in-primitives

92dbabe

ikkoham commented Mar 10, 2023

View reviewed changes

qiskit/primitives/base/base_sampler.py Outdated Show resolved Hide resolved

Update qiskit/primitives/base/base_sampler.py

51943ea

ikkoham marked this pull request as ready for review March 10, 2023 04:44

woodsp-ibm reviewed Mar 10, 2023

View reviewed changes

t-imamichi reviewed Mar 22, 2023

View reviewed changes

mtreinish assigned kevinhartman Apr 11, 2023

kevinhartman reviewed Apr 11, 2023

View reviewed changes

ikkoham commented Apr 12, 2023

View reviewed changes

From review comments

a6b4b43

ikkoham requested a review from kevinhartman April 12, 2023 05:06

ikkoham added the priority: high label Apr 12, 2023

ikkoham mentioned this pull request Apr 12, 2023

Generic PrimitiveJob and BaseSampler/BaseEstimator #9920

Merged

t-imamichi approved these changes Apr 12, 2023

View reviewed changes

Eric-Arellano mentioned this pull request Apr 12, 2023

Apply new deprecation decorators to providers folder #9872

Merged

kevinhartman approved these changes Apr 12, 2023

View reviewed changes

kevinhartman added this pull request to the merge queue Apr 12, 2023

Merged via the queue into Qiskit:main with commit 75673c7 Apr 12, 2023

ikkoham deleted the primitives/rm-in-primitives branch April 13, 2023 03:20

kt474 mentioned this pull request Apr 17, 2023

remove code deprecated after 0.7 release Qiskit/qiskit-ibm-runtime#797

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove deprecated methods and args in Primitives #9480

Remove deprecated methods and args in Primitives #9480

ikkoham commented Jan 30, 2023

qiskit-bot commented Jan 30, 2023

coveralls commented Jan 30, 2023 •

edited

Loading

woodsp-ibm Mar 10, 2023

ikkoham Mar 13, 2023

kevinhartman Apr 11, 2023

t-imamichi Mar 22, 2023

ikkoham Mar 22, 2023

kevinhartman Apr 11, 2023

kevinhartman left a comment

kevinhartman Apr 11, 2023

kevinhartman Apr 11, 2023

kevinhartman Apr 11, 2023

ikkoham Apr 12, 2023

ikkoham left a comment

ikkoham Apr 12, 2023

ikkoham commented Apr 12, 2023

t-imamichi left a comment

kevinhartman left a comment

		super().__init__(options)

		################################################################################

Remove deprecated methods and args in Primitives #9480

Remove deprecated methods and args in Primitives #9480

Conversation

ikkoham commented Jan 30, 2023

Summary

Details and comments

qiskit-bot commented Jan 30, 2023

coveralls commented Jan 30, 2023 • edited Loading

Pull Request Test Coverage Report for Build 4674756685

💛 - Coveralls

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

kevinhartman left a 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

ikkoham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ikkoham commented Apr 12, 2023

t-imamichi left a comment

Choose a reason for hiding this comment

kevinhartman left a comment

Choose a reason for hiding this comment

coveralls commented Jan 30, 2023 •

edited

Loading