Fidelity interface using primitives #8303

ElePT · 2022-07-06T10:33:22Z

Summary

We propose the addition of a series of primitive-based Fidelity interfaces that will become a fundamental building block for primitive-based algorithms: VQD, PVQD, QNSPSA optimizers and quantum kernels.

This PR contains a proposal for BaseStateFidelity and the ComputerUncompute method interface that is used in the refactored quantum kernel class (currently WIP, see design doc and PR). Other methods for calculating state overlaps/ fidelities could be added in the future (i.e. Swap tests, Hadamard tests...).

Details and comments

This PR closes #6876 and #8493.

Update (August 31)

The current implementation follows the design of the new primitive interface, with a run method that returns an AlgorithmJob that is non-blocking. The AlgorithmJob class has been introduced for typing purposes, but in the future it might be modified to include additional/different functionality to PrimitiveJob.

Fidelity primitive POC

qiskit-bot · 2022-07-06T10:33:24Z

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:

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

coveralls · 2022-07-06T11:07:48Z

Pull Request Test Coverage Report for Build 2981696422

126 of 134 (94.03%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.03%) to 84.224%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/algorithms/state_fidelities/base_state_fidelity.py	73	77	94.81%
qiskit/algorithms/state_fidelities/compute_uncompute.py	31	35	88.57%

Totals
Change from base Build 2979080470:	0.03%
Covered Lines:	57176
Relevant Lines:	67886

💛 - Coveralls

qiskit/primitives/fidelity/base_fidelity.py

qiskit/primitives/fidelity/fidelity.py

test/python/primitives/fidelity/test_fidelity.py

Co-authored-by: Julien Gacon <gaconju@gmail.com>

…terra into fidelity-primitive

dlasecki

Overall, it looks reasonable.

qiskit/primitives/fidelity/base_fidelity.py

qiskit/primitives/fidelity/fidelity.py

test/python/primitives/fidelity/test_fidelity.py

Co-authored-by: dlasecki <dal@zurich.ibm.com>

Cryoris

LGTM! Let's see if the docs build passes.... I'll also hold off automerge in case @woodsp-ibm or anybody else wants to have another look!

qiskit/algorithms/state_fidelities/__init__.py

qiskit/algorithms/state_fidelities/base_state_fidelity.py

qiskit/algorithms/state_fidelities/compute_uncompute.py

releasenotes/notes/add-fidelity-interface-primitives-dc543d079ecaa8dd.yaml

qiskit/algorithms/state_fidelities/base_state_fidelity.py

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

…ecaa8dd.yaml Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

ElePT · 2022-09-02T19:04:07Z

Thank you for checking the docs, @woodsp-ibm! I applied all of your suggestions.

woodsp-ibm · 2022-09-02T19:09:54Z

qiskit/algorithms/state_fidelities/compute_uncompute.py

+            fidelities=fidelities,
+            raw_fidelities=raw_fidelities,
+            metadata=result.metadata,
+            run_options=run_opts,


This is just a comment. In gradients, in the result run_options there it says of run_options

run_options for the estimator. Currently, estimator's default run_options is not included.

which is the case here right. So these end up being the options we give to sampler.run() which may then augment them with it own default option.s If run_options were part of Sampler ( and Estimator) result then like metadata it could be result.run_options. But until such time that this happens, its just perhaps something to bear in mind.

qiskit/algorithms/state_fidelities/base_state_fidelity.py

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Cryoris

Thanks a lot for all the effort and patience @ElePT 😁

woodsp-ibm · 2022-09-02T19:43:55Z

Thanks a lot for all the effort and patience @ElePT

Seconded!

* fidelity_poc * init stuff * simplified design * unittests * unittest working * optional parameters * typo * documentation * Update test/python/primitives/fidelity/test_fidelity.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * Update qiskit/primitives/fidelity/base_fidelity.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * black * import order in test fixed * docstring fixed * Update qiskit/primitives/fidelity/base_fidelity.py Co-authored-by: dlasecki <dal@zurich.ibm.com> * context removed * Reset branch * Add init * Fix inits * lint fixes * removed abstractmethod label for set_circuits * added support for setting only one circuit * new unittest * Move fidelities to algorithms * Update interface with new design doc * Fix docstrings and unit tests * Add evaluate * Adapt signature run * Make job async * Fix types * Remove async, cache circuits * Update evaluate method, replace use of np * Remove circuits from init * Add async, tests, update docstrings * Add default run options * change names, abstract methods, improve docstrings * Update docstrings, typing * Fix style * Update qiskit/algorithms/fidelities/base_fidelity.py Co-authored-by: Declan Millar <declan.millar@ibm.com> * Update qiskit/algorithms/fidelities/base_fidelity.py Co-authored-by: Declan Millar <declan.millar@ibm.com> * Make async * Add FidelityResult * Update qiskit/algorithms/fidelities/__init__.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Add to algorithms init * Rename classes * Apply review comments * Update preprocessing * Update docstrings * Move run to base class * Remove left/right params * Apply reviews steve/julien/hamamura * Fix typo * Style changes * Allow different num.params in circuit 1 and 2 * Fix unittest typo * Fix black * Fix docs * Fix style/docstrings * Add AlgorithmJob * Add truncate, fix result docstring * Completely remove left-right * Add comments * Make create circuit public * Remove empty param distinction * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> * change list preprocessing * Update qiskit/algorithms/algorithm_job.py Co-authored-by: Ikko Hamamura <ikkoham@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Apply comments Steve * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * Update test/python/algorithms/state_fidelities/test_compute_uncompute.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * Style changes * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * Apply comments Julien * Style fix * Fix bug for lists of numpy values * Support single circuits * Support single circuits * Add fidelity interface using primitives * Apply reviews * Fix docs * Fix docs * Fix docs * Fix lint * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/compute_uncompute.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update releasenotes/notes/add-fidelity-interface-primitives-dc543d079ecaa8dd.yaml Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/__init__.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Update qiskit/algorithms/state_fidelities/base_state_fidelity.py Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: Gian Gentinetta <gian.gentinetta@gmx.ch> Co-authored-by: Gian Gentinetta <31244916+gentinettagian@users.noreply.github.com> Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: dlasecki <dal@zurich.ibm.com> Co-authored-by: Declan Millar <declan.millar@ibm.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> Co-authored-by: Ikko Hamamura <ikkoham@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

gentinettagian and others added 4 commits June 19, 2022 16:57

fidelity_poc

a7ca007

Merge pull request #3 from gentinettagian/fidelity-primitive

aeaf9bf

Fidelity primitive POC

init stuff

8d3e65f

simplified design

12a9746

ElePT requested review from a team, ikkoham and t-imamichi as code owners July 6, 2022 10:33

Cryoris reviewed Jul 6, 2022

View reviewed changes

ElePT requested review from manoelmarques and woodsp-ibm as code owners July 6, 2022 12:32

gentinettagian and others added 8 commits July 7, 2022 11:04

unittests

1c84828

unittest working

ded7d16

optional parameters

e362b5e

typo

78e83ef

documentation

4be8015

Update test/python/primitives/fidelity/test_fidelity.py

26754be

Co-authored-by: Julien Gacon <gaconju@gmail.com>

Update qiskit/primitives/fidelity/base_fidelity.py

b346945

Co-authored-by: Julien Gacon <gaconju@gmail.com>

black

282c301

gentinettagian force-pushed the fidelity-primitive branch from 36e59bf to 282c301 Compare July 7, 2022 09:09

gentinettagian and others added 5 commits July 7, 2022 11:10

Merge branch 'Qiskit:main' into fidelity-primitive

c712adf

import order in test fixed

a8a0831

Merge branch 'fidelity-primitive' of https://github.com/ElePT/qiskit-…

05c662d

…terra into fidelity-primitive

Merge branch 'main' into fidelity-primitive

9e62012

docstring fixed

d2d3e80

dlasecki suggested changes Jul 15, 2022

View reviewed changes

gentinettagian and others added 2 commits July 16, 2022 11:09

Update qiskit/primitives/fidelity/base_fidelity.py

cfa470c

Co-authored-by: dlasecki <dal@zurich.ibm.com>

context removed

c6534c7

ElePT requested a review from eggerdj as a code owner July 18, 2022 15:53

ElePT added 3 commits September 2, 2022 14:51

Fix docs

2a32785

Fix docs

3f3d5d9

Fix lint

637e63e

Cryoris previously approved these changes Sep 2, 2022

View reviewed changes

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/__init__.py Show resolved Hide resolved

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/base_state_fidelity.py Outdated Show resolved Hide resolved

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/base_state_fidelity.py Outdated Show resolved Hide resolved

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/compute_uncompute.py Outdated Show resolved Hide resolved

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

releasenotes/notes/add-fidelity-interface-primitives-dc543d079ecaa8dd.yaml Outdated Show resolved Hide resolved

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/base_state_fidelity.py Show resolved Hide resolved

Update qiskit/algorithms/state_fidelities/base_state_fidelity.py

78d6b79

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

ElePT dismissed Cryoris’s stale review via 78d6b79 September 2, 2022 18:59

ElePT and others added 5 commits September 2, 2022 20:59

Update qiskit/algorithms/state_fidelities/base_state_fidelity.py

f17c92f

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Update qiskit/algorithms/state_fidelities/compute_uncompute.py

5cda299

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Update releasenotes/notes/add-fidelity-interface-primitives-dc543d079…

f812476

…ecaa8dd.yaml Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Update qiskit/algorithms/state_fidelities/__init__.py

c6f25c1

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Update qiskit/algorithms/state_fidelities/base_state_fidelity.py

d745b4e

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

woodsp-ibm reviewed Sep 2, 2022

View reviewed changes

qiskit/algorithms/state_fidelities/base_state_fidelity.py Outdated Show resolved Hide resolved

Update qiskit/algorithms/state_fidelities/base_state_fidelity.py

9fc65ce

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

Cryoris approved these changes Sep 2, 2022

View reviewed changes

Cryoris added the automerge label Sep 2, 2022

woodsp-ibm approved these changes Sep 2, 2022

View reviewed changes

Merge branch 'main' into fidelity-primitive

d6dfcdc

mergify bot merged commit 9ddc97d into Qiskit:main Sep 2, 2022

woodsp-ibm mentioned this pull request Sep 26, 2022

Implement fidelity algorithms with primitives. #8493

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fidelity interface using primitives #8303

Fidelity interface using primitives #8303

ElePT commented Jul 6, 2022 •

edited

Loading

qiskit-bot commented Jul 6, 2022

coveralls commented Jul 6, 2022 •

edited

Loading

dlasecki left a comment

Cryoris left a comment

ElePT commented Sep 2, 2022

woodsp-ibm Sep 2, 2022

Cryoris left a comment

woodsp-ibm commented Sep 2, 2022

Fidelity interface using primitives #8303

Fidelity interface using primitives #8303

Conversation

ElePT commented Jul 6, 2022 • edited Loading

Summary

Details and comments

Update (August 31)

qiskit-bot commented Jul 6, 2022

coveralls commented Jul 6, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2981696422

💛 - Coveralls

dlasecki left a comment

Choose a reason for hiding this comment

Cryoris left a comment

Choose a reason for hiding this comment

ElePT commented Sep 2, 2022

woodsp-ibm Sep 2, 2022

Choose a reason for hiding this comment

Cryoris left a comment

Choose a reason for hiding this comment

woodsp-ibm commented Sep 2, 2022

ElePT commented Jul 6, 2022 •

edited

Loading

coveralls commented Jul 6, 2022 •

edited

Loading