Skip to content

Documentation requirements for open source #149

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.

Sign up for GitHub

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

Jump to bottom
Open
1 of 17 tasks
jon-wurtz opened this issue Feb 21, 2025 · 0 comments
Open
1 of 17 tasks

Documentation requirements for open source #149

jon-wurtz opened this issue Feb 21, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jon-wurtz
Copy link
Contributor

jon-wurtz commented Feb 21, 2025 •
edited
Loading

Vision for the bloqade family

  • "Essay" page on what we want to get out of bloqade. MLIR, co-design, hardware orientation, etc.

Examples with some essays explaining what we're doing (and why it is cool!)

  • GHZ example - sequential, parallel
  • Pauli exponentiation - Composition of closures
  • QAOA - SIMD parallelism
  • QFT - Recursion
  • Repeat Until Success - Control flow

Interpreter documentation pages

  • QASM2 codegen and API
  • Pyqrack API

Compiler pass examples - under "digital tutorial" tab as "Example compiler passes"

  • Native gate set rewrite
  • ASAP parallelism rewrite
  • Many-to-one qubit unitaries

Restructure Digital->qasm2 and add new pages

  • Top level "Digital" is renamed as "Circuits" and inherits the top words of qasm page. Include discussion on @ qasm kernel decorator and reference code and compiler pass examples.
  • New sub-page on core (qasm2) dialect set with API reference
  • New sub-page on uop dialect set with API reference
  • New sub-page on noise dialect set with API reference
  • New sub-page on parallel (qasm2) dialect set with API reference
  • New sub-page on inline (qasm2) dialect set with API reference
    We can restructure this flow as more dialect groups (e.g. moves) become available.
@jon-wurtz jon-wurtz added the documentation Improvements or additions to documentation label Feb 21, 2025
@jon-wurtz jon-wurtz mentioned this issue Feb 24, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jon-wurtz