KIRIN
Kernel Intermediate Representation INfrastructure
[!IMPORTANT]
This project is in the early stage of development. API and features are subject to change. If you are concerned about the stability of the APIs, consider pinning the version of Kirin in your project.
Installation
Install via uv (Recommended)
uv add kirin-toolchain
Install via pip
pip install kirin-toolchain
Documentation
The documentation is available at https://queracomputing.github.io/kirin/latest/. We are at an early stage of completing the documentation with more details and examples, so comments and contributions are most welcome!
Community
- Slack: join our Slack.
- GitHub Discussions: discussion board for questions, feature requests, and more. GitHub Discussions.
Projects using Kirin
Quantum Computing
We are actively using Kirin at QuEra Computing. Here are some open-source eDSLs for quantum computing that we have developed using Kirin:
- bloqade.qasm2: This is an eDSL for quantum computing that uses Kirin to define an eDSL for the Quantum Assembly Language (QASM) 2.0. It demonstrates how to create multiple dialects using Kirin, run custom analysis and rewrites, and generate code from the dialects (back to QASM 2.0 in this case).
- bloqade.stim: This is an eDSL for quantum computing that uses Kirin to define an eDSL for the STIM language. It demonstrates how to create multiple dialects using Kirin, run custom analysis and rewrites, and generate code from the dialects (back to Stim in this case).
- bloqade.qBraid: This example demonstrates how to lower from an existing representation into the Kirin IR by using the visitor pattern.
Roadmap
We use github issues to track the roadmap. There are more feature requests and proposals in the issues. Here are some of the most wanted features we wish to implement before a beta release:
- Initial version of the IR
- Interpretation framework
- Basic analysis and transformations (e.g. constant folding, type inference, etc.)
- Documentation
- proper stack trace for errors (#13)
- text format (#199)
- Integration with LLVM (#294)
- Integration with MLIR (IRDL) (#293)
- IR serialization + deserialization (#291)
Proposal for the roadmap and feature requests are welcome!
License
Apache License 2.0 with LLVM Exceptions
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kirin_toolchain-0.22.13.tar.gz.
File metadata
- Download URL: kirin_toolchain-0.22.13.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5098d1870b6f0ac3f4a583f5c708af1d86536a033de698af104a8635aac1ce5
|
|
| MD5 |
e66f218a6dd7feb57bc77d67ffa9a85f
|
|
| BLAKE2b-256 |
2a616a4d2c722b58335499aa33994b934ab2e5dd6ebd37cfc38a643132792799
|
Provenance
The following attestation bundles were made for kirin_toolchain-0.22.13.tar.gz:
Publisher:
release.yml on QuEraComputing/kirin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kirin_toolchain-0.22.13.tar.gz -
Subject digest:
b5098d1870b6f0ac3f4a583f5c708af1d86536a033de698af104a8635aac1ce5 - Sigstore transparency entry: 2449260654
- Sigstore integration time:
-
Permalink:
QuEraComputing/kirin@d7e6b04cc83043f5312de255905cc122b4e9e011 -
Branch / Tag:
refs/tags/v0.22.13 - Owner: https://github.com/QuEraComputing
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@d7e6b04cc83043f5312de255905cc122b4e9e011 -
Trigger Event:
push
-
Statement type:
File details
Details for the file kirin_toolchain-0.22.13-py3-none-any.whl.
File metadata
- Download URL: kirin_toolchain-0.22.13-py3-none-any.whl
- Upload date:
- Size: 260.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5df68d0b2c536eeae7a279914afee0f2169ea17e4142fb8fa0be383c9611c4f
|
|
| MD5 |
ee0e8541b5a42d4185b4795ccda949a7
|
|
| BLAKE2b-256 |
d351710792ef144c2c61ea95407ca611d6400a6d16bc4f51d3743fcb063d3774
|
Provenance
The following attestation bundles were made for kirin_toolchain-0.22.13-py3-none-any.whl:
Publisher:
release.yml on QuEraComputing/kirin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kirin_toolchain-0.22.13-py3-none-any.whl -
Subject digest:
b5df68d0b2c536eeae7a279914afee0f2169ea17e4142fb8fa0be383c9611c4f - Sigstore transparency entry: 2449260693
- Sigstore integration time:
-
Permalink:
QuEraComputing/kirin@d7e6b04cc83043f5312de255905cc122b4e9e011 -
Branch / Tag:
refs/tags/v0.22.13 - Owner: https://github.com/QuEraComputing
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@d7e6b04cc83043f5312de255905cc122b4e9e011 -
Trigger Event:
push
-
Statement type:
