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 all example notebooks to docs #30

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Conversation

a-auer
Copy link
Contributor

@a-auer a-auer commented Jan 9, 2025

Adding all (remaining) example notebooks to docs:

  • CLOPS
  • GHZ
  • GST
  • iRB
  • MRB
  • Q-Score
  • QV
  • All experiments notebook (renamed title)

Added new "Development" section

  • generate_2qubit_cliffords
  • how_to_make_your_own_benchmark

Adapted .gitignore.

@a-auer a-auer marked this pull request as ready for review January 13, 2025 16:07
@@ -26,7 +26,6 @@
BenchmarkRunResult,
)
from .circuit_containers import BenchmarkCircuit, CircuitGroup, Circuits
from .compressive_gst.compressive_gst import CompressiveGST, GSTConfiguration
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you pull the latest changes from main into your branch?

There was a PR a few days ago handling the import issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. (Also updated changelog.)

Copy link
Member

@manzanillo manzanillo left a comment

Choose a reason for hiding this comment

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

Overall looks fine to me, only the LaTex rendering should be checked

docs/examples/examples.rst Show resolved Hide resolved
docs/development/development.rst Show resolved Hide resolved
@@ -0,0 +1,8 @@
Development
Copy link
Member

Choose a reason for hiding this comment

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

Maybe "Development" is a little ambigous.
How about "Custom Benchmarks"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rabrie what's your opinion?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Custom benchmarks would fit too, but I'm worried that a user could think this means adapting the settings of an existing benchmark, rather than creating one from scratch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll leave it for now.

manzanillo and others added 3 commits January 14, 2025 14:51
Co-authored-by: Stefan Seegerer <stefan.seegerer@meetiqm.com>
Co-authored-by: Stefan Seegerer <stefan.seegerer@meetiqm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants