Python based QIR generator library.
Project description
pyqir-generator
The pyqir-generator
package provides the ability to generate
QIR using a Python API.
It is intended to be used by code automating translation processes enabling the conversion in some format to QIR via Python; i.e., this is a low-level API intended to be used as a bridge to existing Python frameworks enabling the generation of QIR rather than directly consumed by an end-user. It is not intended to be used as a framework for algorithm and application development.
Installation
The package is released on PyPI and can be installed via pip:
pip install pyqir-generator
Examples
There are generator examples in the repository.
Let's look at a short example. The following code creates QIR for a Bell pair before measuring each qubit and returning the result. The unoptimized QIR is displayed in the terminal when executed:
from pyqir.generator import BasicQisBuilder, SimpleModule
module = SimpleModule("Bell", num_qubits=2, num_results=2)
qis = BasicQisBuilder(module.builder)
qis.h(module.qubits[0])
qis.cx(module.qubits[0], module.qubits[1])
qis.m(module.qubits[0], module.results[0])
qis.m(module.qubits[1], module.results[1])
print(module.ir())
The QIR output will look like:
; ModuleID = 'Bell'
source_filename = "Bell"
%Qubit = type opaque
%Result = type opaque
define void @main() #0 {
entry:
call void @__quantum__qis__h__body(%Qubit* null)
call void @__quantum__qis__cnot__body(%Qubit* null, %Qubit* inttoptr (i64 1 to %Qubit*))
%result0 = call %Result* @__quantum__qis__m__body(%Qubit* null)
%result1 = call %Result* @__quantum__qis__m__body(%Qubit* inttoptr (i64 1 to %Qubit*))
ret void
}
declare void @__quantum__qis__h__body(%Qubit*)
declare void @__quantum__qis__cnot__body(%Qubit*, %Qubit*)
declare %Result* @__quantum__qis__m__body(%Qubit*)
attributes #0 = { "EntryPoint" "requiredQubits"="2" }
Contributing
There are many ways in which you can contribute to PyQIR, whether by contributing a feature or by engaging in discussions; we value contributions in all shapes and sizes! We refer to this document for guidelines and ideas for how you can get involved.
Contributing a pull request to this repo requires to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. A CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately. Simply follow the instructions provided by the bot. You will only need to do this once.
Building and Testing
See Building.
Current Limitations
- Classical computation and control flow are not yet fully supported.
- Only branching based on measurement results is currently possible.
- See issue #2: Support control flow and classical computation in PyQIR Generator.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for pyqir_generator-0.5.0a1-cp36-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d26881b85f85b87c5133ecd9187b3d0ae19f09236ebf55ac3687b3898ede2e11 |
|
MD5 | 74f5ac49a3ff1d41ded1f2e13d84f08c |
|
BLAKE2b-256 | c02fcaea56906c06127bc1675dc4e61ee94c3139032a3871033b6def53889bb8 |
Hashes for pyqir_generator-0.5.0a1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0af69d31f09ff0166854e252894810fe258afba589241b041d2d05024a4a7c8 |
|
MD5 | 9294d2ee9cae7419c3b2a741484ceb3b |
|
BLAKE2b-256 | fae8c4757dfd36102992e42d205e034468d37ffc8ec04f7e4df443cb3e1ea147 |
Hashes for pyqir_generator-0.5.0a1-cp36-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a959536d3e3e1c6a89b1c4ff83d3c5e0c1ebaf6798b67a17afb5d1a21e0b686 |
|
MD5 | a7bf4742d8205450b27de5041b2b716f |
|
BLAKE2b-256 | 7c57cd4659fcfdac5e71b8721fdb2f6794f9bc2e0e3930bc2ea68fc4e50e39f6 |