Adds QSE user guide #1976
Adds QSE user guide #1976
Conversation
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1976 +/- ##
=======================================
Coverage 98.30% 98.30%
=======================================
Files 87 87
Lines 4118 4118
=======================================
Hits 4048 4048
Misses 70 70 ☔ View full report in Codecov by Sentry. |
|
To fix the https://github.com/unitaryfund/mitiq/actions/runs/5988506263/job/16243757058?pr=1976#step:6:281 I don't know if there's an easier way around this issue but this is how I quickly fixed it in the past. |
Thanks I was a bit confused by this error. Just resolved |
|
I thought I changed the label but I'm still getting the same error, am I missing something? |
There was a problem hiding this comment.
Nice work Sahmoud. This is going to be great to share to external (and internal) users!
- We do want this code to be run as part of the
make docsbuild command, so make sure the code cells use the correct syntax:
```{code-cell} ipython3
# your code
```Check out the underlying ZNE guide source.
- I think it's best practice to capitalize Hamiltonian.
docs/source/guide/qse-3-options.md
Outdated
| Returns: | ||
| The expectation value estimated with QSE. | ||
| ``` | ||
| The inclusion of the cache significantly speeds up the runtime and avoids the need for recomputation of already computed values. Furthermore, it is important to note that the cache gets modified in place. Specifically, the cache be reused between different executions of the program. |
There was a problem hiding this comment.
Let's use the warning directive to warn users that this dictionary gets modified in place. Something like this:
```{warning}
warning message about in place modification
```More info about directives can be found here.
Also, can you clarify the last sentence "Specifically, the cache be reused between different executions of the program."?
There was a problem hiding this comment.
Needs addressed. related to #1976 (comment)
There was a problem hiding this comment.
Added the warning message.
I'm not sure how to clarify the last sentence. I'm trying to say that the user can use the pass the same cache object to execute_with_qse for example if they are assuming the same noise model between executions.
There was a problem hiding this comment.
@andreamari can you help me out a bit with this review and take a look through this file?
There was a problem hiding this comment.
In hindsight this is very obvious, but I just realized now that I should have written all the code in notebooks then exported the .md file from there. I have been editing the files directly in the .md files from the zne examples as templates.
|
hi @natestemen and @bubakazouba, checking if this is on track to close by tomorrow. No worries if not, just want to know whether to include it in milestone 0.29, which closes tomorrow. |
There was a problem hiding this comment.
This is a review of just the theory section. Looks great!
Minor comments are below.
Optional additional comment:
In qse-1-intro.md the function qse_demo() is defined line by line and finally executed. Do you think removing qse_demo() and directly using its body when necessary is better? This is just to make a conscious decision, I am fine with any choice.
|
@natestemen checking with you if this can be approved or there are further changes to ask to @bubakazouba, after @andreamari's review, which provided some suggested edits but approved the theory part. |
docs/source/guide/qse-2-use-case.md
Outdated
|
|
||
| ## Advantages | ||
|
|
||
| The advantage of QSE is that it allows determining the value of excited electronic states without the need for a formal error-correcting procedure. Furthermore, the method is error-agnostic. Computationally, the advantage is eliminating the need for ancilla measurements. |
There was a problem hiding this comment.
This needs addressed. This comment is confusingly displayed by itself, but is related to my previous comment #1976 (comment)
docs/source/guide/qse-3-options.md
Outdated
| Returns: | ||
| The expectation value estimated with QSE. | ||
| ``` | ||
| The inclusion of the cache significantly speeds up the runtime and avoids the need for recomputation of already computed values. Furthermore, it is important to note that the cache gets modified in place. Specifically, the cache be reused between different executions of the program. |
There was a problem hiding this comment.
Needs addressed. related to #1976 (comment)
|
hi @bubakazouba, still interested in working on the QSE docs? No worries if you're too busy right now, we can finish this up for you so everyone can see the great work you've done 💯 |
Hi Misty, sorry for the slow work on this. I will wrap it up this weekend. |
Sorry for the delay! All comments should be addressed now. |
Misty-W
dismissed
natestemen’s stale review
I've addressed the comments in the wording change suggestions, which I've since applied to this PR.
Thanks for finishing this up @bubakazouba! |
Description
Adds QSE user guide. closes #1924
License
Before opening the PR, please ensure you have completed the following where appropriate.