Skip to content
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

add error mitigation explanation notebook #1482

Merged
merged 22 commits into from
Jun 6, 2024

Conversation

kevinsung
Copy link
Collaborator

Fixes #1355 .

No material on PEA yet because it's not exposed as an option.

Co-authored-by: Abdullah Ash- Saki <44783187+ashsaki@users.noreply.github.com>
Co-authored-by: Pedro Rivero <pedro.rivero.ramirez@gmail.com>
@kevinsung kevinsung requested a review from javabster June 3, 2024 13:43
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kevinsung
Copy link
Collaborator Author

Hmm the embedded images seem to be giving the CI issue. Gonna need to investigate...

Copy link
Collaborator

@javabster javabster left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking really good! I think this is going to be a very helpful docs page.

I left some in line comments and I have these general ones:

  • please add a "next steps" section like we do for the other docs pages. I think we can add a link to the tutorial on combining EM techniques, as well as maybe the API reference
  • Do you think we should add a section about PEA? I know it's technically only available through the experimental branch for now but we have docs for other experimental features so I can see a case for including here too

docs/run/error-mitigation-explanation.ipynb Outdated Show resolved Hide resolved
docs/run/error-mitigation-explanation.ipynb Outdated Show resolved Hide resolved
docs/run/error-mitigation-explanation.ipynb Show resolved Hide resolved
docs/run/error-mitigation-explanation.ipynb Show resolved Hide resolved
docs/run/error-mitigation-explanation.ipynb Outdated Show resolved Hide resolved
docs/run/error-mitigation-explanation.ipynb Show resolved Hide resolved
@kevinsung
Copy link
Collaborator Author

kevinsung commented Jun 3, 2024

@javabster I've addressed your comments.

Do you think we should add a section about PEA? I know it's technically only available through the experimental branch for now but we have docs for other experimental features so I can see a case for including here too

I think we should document PEA once it's generally available, since the way that the options are exposed would probably affect the exposition. We shouldn't document options that aren't available yet.

@javabster javabster linked an issue Jun 4, 2024 that may be closed by this pull request
5 tasks
Copy link
Collaborator

@abbycross abbycross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I caught a few small word things - otherwise it reads very well, as always!

Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
kevinsung and others added 3 commits June 6, 2024 15:23
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
@kevinsung kevinsung enabled auto-merge June 6, 2024 19:36
@kevinsung kevinsung added this pull request to the merge queue Jun 6, 2024
Merged via the queue into main with commit 9494046 Jun 6, 2024
4 of 5 checks passed
@kevinsung kevinsung deleted the kjs/error-mitigation-explanation branch June 6, 2024 19:42
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Fixes Qiskit#1355 .

No material on PEA yet because it's not exposed as an
[option](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/options).

---------

Co-authored-by: Abdullah Ash- Saki <44783187+ashsaki@users.noreply.github.com>
Co-authored-by: Pedro Rivero <pedro.rivero.ramirez@gmail.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Arnau Casau <arnaucasau@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add explanatory material on error mitigation techniques
5 participants