Primitive V1 deprecation follow-up #12824

ElePT · 2024-07-26T13:37:25Z

Summary

This PR applies a series of fixes to the messaging introduced in #11490 to further clarify:

difference between V1 and V2
difference between abstract interface and implementation
migration path for deprecated classes

It supersedes #12818 after an offline discussion with @1ucian0.

Details and comments

I am open to suggestions, this is a bit of an intricate message to convey to users.

qiskit-bot · 2024-07-26T13:37:30Z

One or more of the following people are relevant to this code:

@Qiskit/terra-core
@ajavadia
@levbishop
@t-imamichi

coveralls · 2024-07-26T14:01:15Z

Pull Request Test Coverage Report for Build 10140985638

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

21 of 21 (100.0%) changed or added relevant lines in 6 files are covered.
74 unchanged lines in 20 files lost coverage.
Overall coverage increased (+0.003%) to 89.742%

Files with Coverage Reduction	New Missed Lines	%
qiskit/circuit/library/standard_gates/swap.py	1	98.21%
qiskit/circuit/library/standard_gates/rxx.py	1	97.87%
qiskit/primitives/base/base_estimator.py	1	94.59%
qiskit/primitives/base/base_sampler.py	1	96.97%
qiskit/circuit/library/standard_gates/rzx.py	1	97.87%
qiskit/circuit/library/standard_gates/ryy.py	2	95.74%
qiskit/circuit/library/standard_gates/xx_plus_yy.py	2	96.23%
qiskit/circuit/library/standard_gates/xx_minus_yy.py	2	96.23%
qiskit/circuit/library/standard_gates/rzz.py	2	95.45%
qiskit/circuit/library/standard_gates/rz.py	3	96.0%

Totals
Change from base Build 10111859581:	0.003%
Covered Lines:	66779
Relevant Lines:	74412

💛 - Coveralls

1ucian0

Great explanations! Thank you! Some few small non-blocking comments

qiskit/primitives/backend_estimator.py

qiskit/primitives/backend_sampler.py

qiskit/primitives/estimator.py

qiskit/primitives/sampler.py

qiskit/primitives/statevector_estimator.py

qiskit/primitives/statevector_sampler.py

releasenotes/notes/deprecate-primitives-v1.yaml

t-imamichi · 2024-07-29T07:24:13Z

Thank you for following up #12575. It looks good overall and Luciano's suggestions make sense to me too.

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

qiskit/primitives/base/base_estimator.py

qiskit/primitives/primitive_job.py

t-imamichi

I added a few minor comments.

Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com>

t-imamichi

LGTM

* Apply tweaks to deprecation messages, docstrings and release notes. * Fix missing backtick * Apply suggestions from Luciano's code review Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/statevector_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/backend_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/primitive_job.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> * Update qiskit/primitives/base/base_estimator.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> (cherry picked from commit b7d0a97)

* Apply tweaks to deprecation messages, docstrings and release notes. * Fix missing backtick * Apply suggestions from Luciano's code review Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/statevector_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/backend_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/primitive_job.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> * Update qiskit/primitives/base/base_estimator.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> (cherry picked from commit b7d0a97) Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Apply tweaks to deprecation messages, docstrings and release notes. * Fix missing backtick * Apply suggestions from Luciano's code review Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/statevector_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/backend_sampler.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/primitives/primitive_job.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> * Update qiskit/primitives/base/base_estimator.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com>

kalvdans · 2024-11-19T12:47:53Z

README.md is still suggesting to use from qiskit.primitives.sampler import Sampler, please update the example as well to not use deprecated classes.

Apply tweaks to deprecation messages, docstrings and release notes.

66734d5

ElePT requested review from a team as code owners July 26, 2024 13:37

ElePT added this to the 1.2.0 milestone Jul 26, 2024

ElePT added mod: primitives Related to the Primitives module Changelog: None Do not include in changelog labels Jul 26, 2024

Fix missing backtick

cd01872

1ucian0 previously approved these changes Jul 26, 2024

View reviewed changes

Apply suggestions from Luciano's code review

34633c2

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

ElePT dismissed 1ucian0’s stale review via 34633c2 July 29, 2024 07:45

ElePT and others added 2 commits July 29, 2024 09:45

Update qiskit/primitives/statevector_sampler.py

6c6fa0c

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Update qiskit/primitives/backend_sampler.py

9064e4c

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

t-imamichi reviewed Jul 29, 2024

View reviewed changes

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

t-imamichi reviewed Jul 29, 2024

View reviewed changes

qiskit/primitives/primitive_job.py Outdated Show resolved Hide resolved

t-imamichi reviewed Jul 29, 2024

View reviewed changes

1ucian0 and others added 2 commits July 29, 2024 10:39

Update qiskit/primitives/primitive_job.py

9283883

Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com>

Update qiskit/primitives/base/base_estimator.py

242f08a

Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com>

1ucian0 approved these changes Jul 29, 2024

View reviewed changes

1ucian0 enabled auto-merge July 29, 2024 08:55

t-imamichi approved these changes Jul 29, 2024

View reviewed changes

ElePT added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Jul 29, 2024

1ucian0 added this pull request to the merge queue Jul 29, 2024

Merged via the queue into Qiskit:main with commit b7d0a97 Jul 29, 2024
14 of 15 checks passed

mergify bot mentioned this pull request Jul 29, 2024

Primitive V1 deprecation follow-up (backport #12824) #12835

Merged

woodsp-ibm mentioned this pull request Jul 30, 2024

Update gradient logic for Qiskit Rust circuit data implementation qiskit-community/qiskit-algorithms#188

Merged

t-imamichi mentioned this pull request Nov 25, 2024

Replaces V1 Primitives in README.md with V2 Primitives. #13487

Merged

mergify bot mentioned this pull request Nov 25, 2024

Replaces V1 Primitives in README.md with V2 Primitives. (backport #13487) #13491

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Primitive V1 deprecation follow-up #12824

Primitive V1 deprecation follow-up #12824

ElePT commented Jul 26, 2024 •

edited

Loading

qiskit-bot commented Jul 26, 2024

coveralls commented Jul 26, 2024 •

edited

Loading

1ucian0 left a comment

t-imamichi commented Jul 29, 2024 •

edited

Loading

t-imamichi left a comment

t-imamichi left a comment

kalvdans commented Nov 19, 2024

Primitive V1 deprecation follow-up #12824

Primitive V1 deprecation follow-up #12824

Conversation

ElePT commented Jul 26, 2024 • edited Loading

Summary

Details and comments

qiskit-bot commented Jul 26, 2024

coveralls commented Jul 26, 2024 • edited Loading

Pull Request Test Coverage Report for Build 10140985638

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

1ucian0 left a comment

Choose a reason for hiding this comment

t-imamichi commented Jul 29, 2024 • edited Loading

t-imamichi left a comment

Choose a reason for hiding this comment

t-imamichi left a comment

Choose a reason for hiding this comment

kalvdans commented Nov 19, 2024

ElePT commented Jul 26, 2024 •

edited

Loading

coveralls commented Jul 26, 2024 •

edited

Loading

t-imamichi commented Jul 29, 2024 •

edited

Loading