Add QPY serialization for PauliEvolutionGate #7374

mtreinish · 2021-12-08T00:28:57Z

Summary

This commit adds serialization for the PauliEvolutionGate class so that
we can exactly reproduce a PauliEvolutionGate over QPY. This works by
bumping the qpy format version and adding new structs to represent the
PauliEvolutionGate and all it's child attribute types.

Details and comments

If this can be finished and thoroughly tested in time for 0.19.1 we can include this. Otherwise we can come up with a faster workaround and then just save this for 0.20.0 (and probably QPY v4 assuming #7372 is included in 0.19.1 with a format bump to represent ParameterVectorElements).

TODO:

release notes
add support for synthesis class
fix PauliEvolutionGate.operator to not use PauliSumOp (which is incorrect) and use SparsePauliOp directly
Add more test coverage
Add qpy compat tests

This commit adds serialization for the PauliEvolutionGate class so that we can exactly reproduce a PauliEvolutionGate over QPY. This works by bumping the qpy format version and adding new structs to represent the PauliEvolutionGate and all it's child attribute types.

mtreinish · 2021-12-08T00:30:01Z

I've tagged this for 0.19.1 but I'm not optimistic it'll be ready in time so we should not block on this.

This commit fixes the handling of the operator attribute in the PauliEvolutionGate. With this commit we can serialize a PauliEvolutionGate correctly with the exception of it's synthesis class which still needs to be supported.

coveralls · 2021-12-08T13:55:00Z

Pull Request Test Coverage Report for Build 1555898624

118 of 124 (95.16%) changed or added relevant lines in 6 files are covered.
5 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.02%) to 83.12%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/circuit/library/pauli_evolution.py	9	10	90.0%
qiskit/synthesis/evolution/evolution_synthesis.py	3	4	75.0%
qiskit/synthesis/evolution/lie_trotter.py	5	6	83.33%
qiskit/synthesis/evolution/product_formula.py	7	8	87.5%
qiskit/circuit/qpy_serialization.py	93	95	97.89%

Files with Coverage Reduction	New Missed Lines	%
qiskit/extensions/quantum_initializer/uc.py	2	88.65%
qiskit/pulse/library/waveform.py	3	89.36%

Totals
Change from base Build 1555133627:	0.02%
Covered Lines:	51786
Relevant Lines:	62303

💛 - Coveralls

mtreinish · 2021-12-08T16:29:44Z

Ok, this should be ready for review now. I think all the use cases are working.

…qpy-evo-gate

qiskit/circuit/qpy_serialization.py

releasenotes/notes/fix-pauli-evolution-gate-bf85592f0f8f0ba7.yaml

qiskit/circuit/qpy_serialization.py

Co-authored-by: Jake Lishman <jake@binhbar.com>

jakelishman

Looks good to me now. Julien (@Cryoris), have you tested it to make sure it handles your use-case?

jakelishman · 2021-12-08T18:41:37Z

qiskit/circuit/qpy_serialization.py

+        with io.BytesIO() as element_buf:
+            with io.BytesIO() as buf:


No need to change this, but for the future you can avoid an extra scope by doing

with io.BytesIO() as element_buf, io.BytesIO() as buf:

the scope order is guaranteed to be left-to-right. (Assuming it's not a line-length constraint!)

Ah cool, I didn't realize that

Cryoris · 2021-12-08T19:06:35Z

Yes, it fixes the problem locally 👍🏻 as soon as we merged it we can properly test it on the runtime image using Terra main.

* WIP: Add qpy serialization for PauliEvolutionGate This commit adds serialization for the PauliEvolutionGate class so that we can exactly reproduce a PauliEvolutionGate over QPY. This works by bumping the qpy format version and adding new structs to represent the PauliEvolutionGate and all it's child attribute types. * Fix handling of operator in PauliEvolutionGate This commit fixes the handling of the operator attribute in the PauliEvolutionGate. With this commit we can serialize a PauliEvolutionGate correctly with the exception of it's synthesis class which still needs to be supported. * settings for synth * Add support for custom synthesis classes * Expand test coverage * Add release notes * Update release note * fix param binding in PauliEvo * allow time as an int * Apply suggestions from code review Co-authored-by: Jake Lishman <jake@binhbar.com> * Update qiskit/circuit/qpy_serialization.py Co-authored-by: Jake Lishman <jake@binhbar.com> * Update qiskit/circuit/qpy_serialization.py * Rerun with latest black * Close buffers when finished * Fix release note wording * Fix lint * Adjust tests around extra layer of gates Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Jake Lishman <jake@binhbar.com> (cherry picked from commit 9af5ca1)

* WIP: Add qpy serialization for PauliEvolutionGate This commit adds serialization for the PauliEvolutionGate class so that we can exactly reproduce a PauliEvolutionGate over QPY. This works by bumping the qpy format version and adding new structs to represent the PauliEvolutionGate and all it's child attribute types. * Fix handling of operator in PauliEvolutionGate This commit fixes the handling of the operator attribute in the PauliEvolutionGate. With this commit we can serialize a PauliEvolutionGate correctly with the exception of it's synthesis class which still needs to be supported. * settings for synth * Add support for custom synthesis classes * Expand test coverage * Add release notes * Update release note * fix param binding in PauliEvo * allow time as an int * Apply suggestions from code review Co-authored-by: Jake Lishman <jake@binhbar.com> * Update qiskit/circuit/qpy_serialization.py Co-authored-by: Jake Lishman <jake@binhbar.com> * Update qiskit/circuit/qpy_serialization.py * Rerun with latest black * Close buffers when finished * Fix release note wording * Fix lint * Adjust tests around extra layer of gates Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Jake Lishman <jake@binhbar.com> (cherry picked from commit 9af5ca1) Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

mtreinish added on hold Can not fix yet Changelog: Bugfix Include in the "Fixed" section of the changelog labels Dec 8, 2021

mtreinish added this to the 0.19.1 milestone Dec 8, 2021

mtreinish requested a review from Cryoris December 8, 2021 00:28

mtreinish requested a review from a team as a code owner December 8, 2021 00:28

mtreinish added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Dec 8, 2021

Fix handling of operator in PauliEvolutionGate

e8bd3a0

This commit fixes the handling of the operator attribute in the PauliEvolutionGate. With this commit we can serialize a PauliEvolutionGate correctly with the exception of it's synthesis class which still needs to be supported.

Cryoris and others added 6 commits December 8, 2021 15:44

settings for synth

fbc00b7

Merge branch 'evolution-serialization' into qpy-evo-gate

c80bfd6

Merge remote-tracking branch 'origin/main' into qpy-evo-gate

19545ef

Add support for custom synthesis classes

71b6ee4

Expand test coverage

a326154

Add release notes

10531f6

mtreinish changed the title ~~[WIP] Add qpy serialization for PauliEvolutionGate~~ Add QPY serialization for PauliEvolutionGate Dec 8, 2021

mtreinish removed the on hold Can not fix yet label Dec 8, 2021

mtreinish and others added 4 commits December 8, 2021 11:31

Update release note

79e3870

Merge branch 'main' into qpy-evo-gate

8d8de99

fix param binding in PauliEvo

4cc86bd

Merge branch 'qpy-evo-gate' of github.com:mtreinish/qiskit-core into …

0f6c685

…qpy-evo-gate

mtreinish requested review from manoelmarques and woodsp-ibm as code owners December 8, 2021 17:44

allow time as an int

5a28626

jakelishman reviewed Dec 8, 2021

View reviewed changes

mtreinish and others added 3 commits December 8, 2021 13:00

Apply suggestions from code review

f59887e

Co-authored-by: Jake Lishman <jake@binhbar.com>

Update qiskit/circuit/qpy_serialization.py

3034922

Co-authored-by: Jake Lishman <jake@binhbar.com>

Update qiskit/circuit/qpy_serialization.py

44d36df

Rerun with latest black

babce2e

jakelishman mentioned this pull request Dec 8, 2021

Fix ParameterVector handling in QPY serialization #7381

Merged

4 tasks

mtreinish added 2 commits December 8, 2021 13:36

Close buffers when finished

82d3576

Fix release note wording

7852fc9

mtreinish requested a review from jakelishman December 8, 2021 18:39

jakelishman previously approved these changes Dec 8, 2021

View reviewed changes

Fix lint

05359d2

mtreinish dismissed jakelishman’s stale review via 05359d2 December 8, 2021 19:09

jakelishman previously approved these changes Dec 8, 2021

View reviewed changes

jakelishman added the automerge label Dec 8, 2021

Adjust tests around extra layer of gates

523150b

mtreinish dismissed jakelishman’s stale review via 523150b December 8, 2021 20:42

kdk approved these changes Dec 8, 2021

View reviewed changes

mergify bot merged commit 9af5ca1 into Qiskit:main Dec 8, 2021

mergify bot mentioned this pull request Dec 8, 2021

Add QPY serialization for PauliEvolutionGate (backport #7374) #7382

Merged

mtreinish deleted the qpy-evo-gate branch December 8, 2021 21:48

daka1510 mentioned this pull request Dec 13, 2021

Tests started failing without code change in qiskit-ibm-runtime Qiskit/qiskit-ibm-runtime#59

Closed

mtreinish mentioned this pull request Jan 26, 2022

QPY serialization fails for circuits with IfElse instructions #7583

Closed

HuangJunye added the mod: qpy Related to QPY serialization label Apr 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add QPY serialization for PauliEvolutionGate #7374

Add QPY serialization for PauliEvolutionGate #7374

mtreinish commented Dec 8, 2021 •

edited

mtreinish commented Dec 8, 2021

coveralls commented Dec 8, 2021 •

edited

mtreinish commented Dec 8, 2021

jakelishman left a comment

jakelishman Dec 8, 2021

mtreinish Dec 8, 2021

Cryoris commented Dec 8, 2021

Add QPY serialization for PauliEvolutionGate #7374

Add QPY serialization for PauliEvolutionGate #7374

Conversation

mtreinish commented Dec 8, 2021 • edited

Summary

Details and comments

mtreinish commented Dec 8, 2021

coveralls commented Dec 8, 2021 • edited

Pull Request Test Coverage Report for Build 1555898624

💛 - Coveralls

mtreinish commented Dec 8, 2021

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman Dec 8, 2021

Choose a reason for hiding this comment

mtreinish Dec 8, 2021

Choose a reason for hiding this comment

Cryoris commented Dec 8, 2021

mtreinish commented Dec 8, 2021 •

edited

coveralls commented Dec 8, 2021 •

edited