docs: update Algorithmiq TEM documentation and tutorial#4639
docs: update Algorithmiq TEM documentation and tutorial#4639robertodr wants to merge 20 commits intoQiskit:mainfrom
Conversation
Signed-off-by: Roberto Di Remigio Eikås <robertodr@users.noreply.github.com>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
Thanks for contributing to Qiskit documentation! 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. Thanks! 🙌 One or more of the following people are relevant to this code: |
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
You are correct @HuangJunye, it appears this PR is based on an outdated version of the repo, and isn't including updates to this file that are on the latest main branch. @robertodr can you note the needed updates for the Guide, and then pull the current version of that guide file from main and apply just your newest changes?
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
The formatting of the table seems to have issues, at least viewing on reviewnb. Can you please double check?
Reply via ReviewNB
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
The rendering after num_readout_calibration_shots is off as well, at least viewing on reviewnb. Can you please double check the formatting?
I like the newly added options and the explanation for precision.
Reply via ReviewNB
There was a problem hiding this comment.
Now the whole table rendering is off. Can you please take a look?
| @@ -5,12 +5,6 @@ | |||
| "id": "f7d9993f", | |||
There was a problem hiding this comment.
Has the resource_usage metadata been removed from the latest version of the function? I think those info are very useful.
Reply via ReviewNB
|
@robertodr Thanks a lot for adding the new docs. I have reviewed the updated user guide and left some comments. Can you please also take a look at the linting error:
I will review the new tutorial shortly. |
|
@robertodr I would like to push several commits that will fix the linting errors, but I don't have access to this branch. Can you see if it's possible in the settings for your copy of the repo, to check "Allow edits and access to secrets by maintainers"? https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork |
|
@abbycross I'm unable to find that option... I can't even edit the title of the PR 🤔 |
|
Hm @robertodr GitHub sometimes works against us 🤣 I think perhaps the right starting place is to return the |
|
|
…rithmiq/documentation into docs-update-algorithmiq-tem
Ajc branch tem
HuangJunye
left a comment
HuangJunye
left a comment
There was a problem hiding this comment.
Thanks a lot for adding the tutorial. This is a first part review. Overall it looks great. I am running jobs to validate the codes are working as expected.
There was a problem hiding this comment.
Should we rename this file to distinguish it from the guide? The corresponding index, json, toml, yaml files will need to be updated as well if we do so.
There was a problem hiding this comment.
I agree - to avoid confusion we should have different names. In my PR I have changed it to simulate-kicked-ising-tem.ipynb
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "%pip install numpy matplotlib qiskit qiskit_ibm_catalog qiskit-ibm-runtime" |
There was a problem hiding this comment.
| "%pip install numpy matplotlib qiskit qiskit_ibm_catalog qiskit-ibm-runtime" | |
| "%pip install numpy matplotlib qiskit qiskit-ibm-catalog qiskit-ibm-runtime" |
Unify the style. Use - instead of _ for pip install
| @@ -0,0 +1,869 @@ | |||
| { | |||
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
Can you create the circuit using Qiskit instead of loading a .qpy file? We want to minimize data storage on the docs for security compliance.
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
@abbycross Is there a standard / recommended way for writing api_key, channel and crn?
Reply via ReviewNB
There was a problem hiding this comment.
We don't have a standard, but for the token I would recommend <API-KEY> since that is how IBM Cloud refers to them.
The default channel is "ibm_quantum_platform".
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
I got 0.9566488314675223 ± 0.04520526641815972 from ibm_boston which is pretty good!
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
Line #8. print(f"TEM Result: {tem_evs} ± {tem_std}")
Can you match the format with the job with custom options?
print(f"TEM Result: {tem_evs:.3f} ± {tem_std:.3f}")
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
Line #8. options |= nl_options
Can you please add a comments after this line: "Add noise learning options to the overall options" because |= is not a very commonly used python operator.
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
Create the circuit using Qiskit instead of loading a qpy file, similar to the first circuit
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
tem job is not set as private by default, right? I can't see how to set private mode in the user guide: https://quantum.cloud.ibm.com/docs/en/guides/algorithmiq-tem I think we don't need to mention private mode in the tutorial.
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
The results are not as good as the default setting for some reasons. I got 0.937 ± 0.013 on ibm_boston
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
The unmitigated result is worse than the default setting on boston as well 0.905 ± 0.010.
Reply via ReviewNB
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
| @@ -0,0 +1,869 @@ | |||
| { | |||
There was a problem hiding this comment.
|
@robertodr @HuangJunye since I don't have write access to this branch, I opened another PR in the Algorithmiq repo to address some of the structural/linting changes. I renamed the file there. There's also some copyediting to do, but I need to wait to do that till all the content changes that @HuangJunye has made are resolved. I'll plan to do the copyedits in a followup PR. |
7 participants
No description provided.