-
-
Notifications
You must be signed in to change notification settings - Fork 166
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Quick fix: Fix typo and headings in classical shadows tutorial #2574
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @JMuff22, thank you for submitting a PR to Mitiq! We will respond as soon as possible, and if you have any questions in the meantime, you can ask us on the Unitary Fund Discord.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2574 +/- ##
=======================================
Coverage 98.72% 98.72%
=======================================
Files 92 92
Lines 4168 4168
=======================================
Hits 4115 4115
Misses 53 53 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
Hi @JMuff22, thank you for your correction! Cleaning up this tutorial is on our list of todos #2110
I have a very high-level understanding of how this technique works. Is there a particular spot where this remark might be useful?
I think this equation is directly taken from the paper. See eq S13 in the supplementary info. |
Yes S13 without remark 1 is confusing in my opinion. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! Thanks for the patch.
I agree the remark would be helpful here. Is that something you'd like to add to this PR?
By the way, is there a quicker way of building the documentation for quick fixes? I noticed that |
Added my suggested fix. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Jake! BTW are you using the mitiq.shadows
module in practice? Would love to get your thoughts/opinions on how it's going if so.
|
I am not really using it in practice. Maybe in the future. I was more using it to learn the protocol and apply it myself. |
Description
I noticed some typos and an unrendered heading in the classical shadows documentation. These are fixed here.
Additionally, if you (the maintainers) think it useful I think it would be good to highlight Remark 1 from the paper (https://arxiv.org/abs/2002.08953)
In the shadows_tutorial for equation (10). I think the sudden appearance of
34
is confusing in the guide.License
Before opening the PR, please ensure you have completed the following where appropriate.