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 benchmarks to user guide #2274

Open
nathanshammah opened this issue Apr 9, 2024 · 5 comments · May be fixed by #2566
Open

Add benchmarks to user guide #2274

nathanshammah opened this issue Apr 9, 2024 · 5 comments · May be fixed by #2566
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@nathanshammah
Copy link
Member

Issue Description

Benchmark quantum circuit are a crucial ingredient to test empirically the performance of quantum error mitigation techniques on real or simulated devices, and can be used as a diagnostic tool when designing new techniques or modifying existing ones. They are also used in the calibrator. While some benchmarks are quite well known, as randomized benchmarking or GHZ, others have been proposed more recently, like quantum volume circuits and mirror quantum circuits.

Mitiq provides a comprehensive list of quantum circuits that can be used for benchmarks and they are listed in the API doc. However, their usage may require some additional background information. Moreover, they can be of use for several tutorials and to get started with Mitiq.

Proposed Solution

I propose to add a section in the documentation, in the user guide, under the core concepts, listing the various quantum circuits present in the benchmarks, with some details and code blocks, and useful references.

Additional References

@nathanshammah nathanshammah added documentation Improvements or additions to documentation feature-request A request for a feature, tool, or workflow in Mitiq. labels Apr 9, 2024
@nathanshammah
Copy link
Member Author

@FarLab I'd be happy to work on this, it could even make it into this milestone.

@nathanshammah nathanshammah added this to the v0.36.0 milestone Apr 10, 2024
@natestemen natestemen removed the feature-request A request for a feature, tool, or workflow in Mitiq. label Apr 10, 2024
@cosenal cosenal modified the milestones: v0.36.0, v0.37.0 May 3, 2024
@cosenal cosenal modified the milestones: v0.37.0, v0.38.0 May 31, 2024
@jordandsullivan jordandsullivan modified the milestones: v0.38.0, 0.39.0 Jun 28, 2024
@natestemen natestemen modified the milestones: 0.39.0, 0.40.0 Aug 5, 2024
@natestemen natestemen modified the milestones: 0.40.0, 0.41.0 Oct 9, 2024
@purva-thakre purva-thakre added the good first issue Good for newcomers label Oct 11, 2024
@natestemen natestemen modified the milestones: 0.41.0, 0.42.0 Nov 7, 2024
@Shivansh20128
Copy link

HI @purva-thakre ! Can you assign this to me.
Thanks

@purva-thakre
Copy link
Collaborator

@Shivansh20128 Assigned! Feel free to ask questions if you run into any problems!

Our documentation also contains information about how to add files to the docs etc.: https://mitiq.readthedocs.io/en/latest/contributing_docs.html

@Shivansh20128
Copy link

Okay. Thank you!

@Shivansh20128
Copy link

I am going through the API Doc and reading about the various benchmark circuits. But I saw that the index on the right side shows "Tools for Error Mitigation" and a sub heading "Benchmarks", but then no sub headings for each of the benchmark circuits. Maybe this is something we can add as well.

@Shivansh20128 Shivansh20128 linked a pull request Nov 12, 2024 that will close this issue
6 tasks
@natestemen natestemen linked a pull request Nov 12, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants