Skip to content

Compiler pass example documentation #152

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

Open
3 tasks
jon-wurtz opened this issue Feb 21, 2025 · 4 comments
Open
3 tasks

Compiler pass example documentation #152

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

Comments

@jon-wurtz
Copy link
Contributor

Add pages on example compiler passes under "digital tutorial" tab as "example compiler passes"

  • Native gate set rewrite
  • ASAP parallelism rewrite
  • Many-to-one qubit unitaries
@jon-wurtz jon-wurtz added the documentation Improvements or additions to documentation label Feb 21, 2025
@weinbe58
Copy link
Member

I think these might be better as blog posts since they will requires talking about how to use the compiler infrastructure.

@jon-wurtz
Copy link
Contributor Author

We can have an associated blog post, but the problem is that these passes as it stands are completely undocumented.

@Roger-luo
Copy link
Member

Roger-luo commented Feb 25, 2025

What about a separate section in the main documentation that just list the docstrings for now? We can add some basic examples in the docstrings.

I think the problem is that using them without a baisc understanding of Kirin would be hard. So we should not expect users to only read the docstrings in bloqade.

@jon-wurtz
Copy link
Contributor Author

Yes, docstrings is fine for now. The intent for now can be just show that we "have" these compiler passes. Pages here https://github.com/QuEraComputing/bloqade/tree/main/docs/quick_start/circuits/compiler_passes

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
Projects
None yet
Development

No branches or pull requests

3 participants