Add tutorial on Quantum Phase Estimation #535

Exferro · 2022-08-02T21:58:52Z

Before submitting

Please complete the following checklist when submitting a PR:

Ensure that your tutorial executes correctly, and conforms to the
guidelines specified in the README.
Add a thumbnail link to your tutorial in beginner.rst, or if a
QML implementation, in implementations.rst.
All QML tutorials conform to
PEP8 standards.
To auto format files, simply pip install black, and then
run black -l 100 path/to/file.py.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.

Title: Quantum Phase Estimation for Molecular Ground State Energies

Summary:

Relevant references:

Possible Drawbacks:

Related GitHub Issues:

github-actions · 2022-08-02T22:17:55Z

Thank you for opening this pull request.

You can find the built site at this link.

Deployment Info:

Pull Request ID: 535
Deployment SHA: 6b0bb15e5e7879a66a3feed3bd558d94d2a2d4d1
(The Deployment SHA refers to the latest commit hash the docs were built from)

Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.

KetpuntoG

Here is a first round of comments. It looks good!
There are still things to correct 😄
be careful with taking for granted things that the reader does not have to know

KetpuntoG · 2022-08-11T17:25:53Z

demonstrations/tutorial_qpe.py

@@ -0,0 +1,803 @@
+"""
+Title: Quantum Phase Estimation for molecular energies Date: 2022-07-25


The format is different from the how-tos, see this example

:

KetpuntoG · 2022-08-11T17:28:17Z

demonstrations/tutorial_qpe.py

+
+######################################################################
+# Hi! It seems that you were wandering around the PennyLane website and
+# opened the demo called “Finding Ground State Energies via Quantum Phase


The name that appears in the website is "Relating energies to quantum phases". I think when you change the title format it will fix itself.

demonstrations/tutorial_qpe.py

KetpuntoG · 2022-08-11T19:26:39Z

demonstrations/tutorial_qpe.py

+    ax.set_xlabel("Readout bitstring index ($l$)")
+    ax.set_ylabel(r"Measurement probability ($\left|\alpha_l\right|^2$)")
+    ax.legend()
+


Write plt.show() to avoid warnings.

Also the xkcd fonts are not found and generating an error for me.

The orange line in this plot is hard to see

And the axis label is cut off.

KetpuntoG · 2022-08-11T19:28:07Z

demonstrations/tutorial_qpe.py

+# determinants with different number of electrons.
+# 
+# Altogether all this completely spoils the estimate of the QPE circuit
+# even for a simple system as H\ :math:`_3^{+}` :/. On the other hand the


you can use emojis if you want haha 🤨😮🤯

KetpuntoG · 2022-08-11T19:29:52Z

demonstrations/tutorial_qpe.py

+    ax.set_yscale('log')
+
+
+######################################################################


Image appears cropped

Perhaps connecting the dots with a line would make it clearer. The first time I didn't see the bottom dot 🙈

KetpuntoG · 2022-08-11T19:35:36Z

demonstrations/tutorial_qpe.py

+# 
+
+######################################################################
+# [1] If not, no worries, but briefly yes, we hope that the


In the demos, the footers do not look good 😅 Try to insert them in the text or simply remove them

KetpuntoG · 2022-08-11T19:37:20Z

demonstrations/tutorial_qpe.py

+
+
+######################################################################
+# {% from ‘author_bio.html’ import author_bio %} {{


the bio is put differently, look at this example. Also, for the authors the image is saved in another folder

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

jen-dodd · 2022-08-23T21:03:53Z

demonstrations/tutorial_qpe.py

+"""
+######################################################################
+#
+# Hi! It seems that you were wandering around the PennyLane website and


I like a casual introduction but I think this will read a little oddly to most people who arrive here as only a minority get here from the website; most come via links from twitter and so on.

demonstrations/tutorial_qpe.py

jen-dodd · 2022-08-23T21:06:23Z

demonstrations/tutorial_qpe.py

+# 1. Quantum computers will make finding the ground state energies easier.
+# 2. The  quantum phase estimation (QPE) algorithm should be somehow involved there — and you are keen to learn how ground state energies and QPE go together.
+#
+# Well, in this case you


Suggested change

# Well, in this case you

#

demonstrations/tutorial_qpe.py

ghost · 2022-10-19T21:36:45Z

demonstrations/tutorial_qpe.py

+# In the next section we will go greedy and will look at the accuracy
+# improvements that we can get by adding more qubits in the readout
+# register :3!
+# 


I'm confused, why use QPE after VQE, if VQE already gave us something very precise? I don't understand the point of this whole exercise much! Could you clarify?

Hi @alvaro-at-xanadu! I've added a small explanation on this point. I agree that for this particular case it is pointless to use the QPE after the VQE which is already giving the exact answer. On the other hand for the demo should be clarifying because corresponds to the textbook case where we are using the exact eigenstate as input for the QPE.

ghost

I learned a lot from this demo! 💯 But to be production-quality, it still needs several changes:

There's an incomplete section
Typos and grammar, acronyms
Some parts require more explanation. Mostly the initial QPE code, the use of QPE after VQE.
Code needs more comments

Please do not click on resolve conversation in any of the comments. Only reviewers will do this. If you need to implement a suggestion, click on commit suggestion. And if you've already fixed some of these locally, please don't forget to push the latest version as you do!

KetpuntoG · 2022-10-31T14:15:39Z

I learned a lot from this demo! 💯 But to be production-quality, it still needs several changes:

There's an incomplete section

Typos and grammar, acronyms

Some parts require more explanation. Mostly the initial QPE code, the use of QPE after VQE.

Code needs more comments

Please do not click on resolve conversation in any of the comments. Only reviewers will do this. If you need to implement a suggestion, click on commit suggestion. And if you've already fixed some of these locally, please don't forget to push the latest version as you do!

@Exferro @davidecast , could you work on the requested changes?
Remark again, you will have to click on commit suggestion if you accept the change :)

Co-authored-by: alvaro-at-xanadu <91897656+alvaro-at-xanadu@users.noreply.github.com>

Exferro · 2022-11-12T13:18:46Z

Hey @KetpuntoG!
I know, this is long overdue, but I got buried under lots of academic/teaching obligations, I will get back to this demo when the Oxford term is over, i.e. on the week starting December 5.

Sorry for keeping postponing!

KetpuntoG · 2022-12-28T15:16:46Z

Let's try to finish this soon in January :)

KetpuntoG · 2023-01-16T23:05:57Z

@Exferro @davidecast please do not leave this

davidecast · 2023-01-19T16:21:12Z

Hi @KetpuntoG!

Sorry for replying late and that we are dragging our last fixes, I will work on the remaining changes requested in the next days and then @Exferro will go on from there.

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

KetpuntoG · 2023-12-06T20:38:44Z

A new QPE demo with the new PL features is on the way. I close this PR as it is not expected to be merged

Add first draft of the demo

562e3af

davidecast added 2 commits August 3, 2022 22:46

fixed formatting

8fd59c9

other fix of formatting

7256754

KetpuntoG reviewed Aug 11, 2022

View reviewed changes

Exferro and others added 17 commits August 17, 2022 13:37

Update demonstrations/tutorial_qpe.py

ff0d55d

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

3824e77

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

65f1f90

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

da531a5

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

1610846

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

043eb49

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

6f65633

Co-authored-by: Guillermo Alonso-Linaje <65235481+KetpuntoG@users.noreply.github.com>

first part of the review

e5ceddd

Fix bug with non-existing imports

143abc2

Add header

279e91c

Move the demo file to a proper folde

d56998f

Merge branch 'PennyLaneAI:master' into tutorial_qpe

4f9dd61

Fix header bug

a57ec5e

Fix HF bug

620dc4f

Fix plotting bug

f7d7ef8

Fix one more annoying plotting bug

f024797

Implement changes in the theory part

90b3ccd

jen-dodd self-requested a review August 23, 2022 20:48

jen-dodd reviewed Aug 23, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

jen-dodd reviewed Aug 23, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

jen-dodd reviewed Aug 23, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

jen-dodd reviewed Aug 23, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

jen-dodd reviewed Aug 23, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

ghost reviewed Oct 19, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

ghost reviewed Oct 19, 2022

View reviewed changes

demonstrations/tutorial_qpe.py Outdated Show resolved Hide resolved

ghost reviewed Oct 19, 2022

View reviewed changes

ghost suggested changes Oct 19, 2022

View reviewed changes

davidecast and others added 5 commits November 7, 2022 17:00

Update demonstrations/tutorial_qpe.py

63e47a5

Co-authored-by: alvaro-at-xanadu <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

0b23b0b

Co-authored-by: alvaro-at-xanadu <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

49d9892

Co-authored-by: alvaro-at-xanadu <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

9fe34a7

Co-authored-by: alvaro-at-xanadu <91897656+alvaro-at-xanadu@users.noreply.github.com>

comments to code and VQE section

8987444

davidecast and others added 14 commits January 22, 2023 15:49

Update demonstrations/tutorial_qpe.py

7cfa72b

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

6e5089a

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

1bed4e9

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

f5efa75

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

8c50386

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

3cc25b9

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

94b6b84

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

f61aadf

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

3eb5159

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

2cdd038

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

6a0588d

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

6d576b5

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Update demonstrations/tutorial_qpe.py

718d225

Co-authored-by: Alvaro Ballon <91897656+alvaro-at-xanadu@users.noreply.github.com>

Merge branch 'master' into tutorial_qpe

6b0bb15

KetpuntoG closed this Dec 6, 2023

		@@ -0,0 +1,803 @@
		"""
		Title: Quantum Phase Estimation for molecular energies Date: 2022-07-25

		ax.set_yscale('log')


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



		######################################################################
		# {% from ‘author_bio.html’ import author_bio %} {{

Add tutorial on Quantum Phase Estimation #535

Add tutorial on Quantum Phase Estimation #535

Uh oh!

Conversation

Exferro commented Aug 2, 2022

Before submitting

Uh oh!

github-actions bot commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KetpuntoG left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

KetpuntoG commented Oct 31, 2022

Uh oh!

Exferro commented Nov 12, 2022

Uh oh!

KetpuntoG commented Dec 28, 2022

Uh oh!

KetpuntoG commented Jan 16, 2023

Uh oh!

davidecast commented Jan 19, 2023

Uh oh!

KetpuntoG commented Dec 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions bot commented Aug 2, 2022 •

edited

Loading