Update README.md

README.md

@@ -1,3 +1,40 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+tags:
+- physics
+- diffusion-model
+- quantum-information
+- quantum-circuits
+- genQC
+pipeline_tag: other
+library_name: genQC
+---
+
+# Compile discrete-continuous quantum circuits 3 to 5 qubits
+
+Paper: ["Synthesis of discrete-continuous quantum circuits with multimodal diffusion models"](https://www.arxiv.org/abs/2506.01666).
+
+Project page: https://florianfuerrutter.github.io/genQC/
+
+![](https://github.com/FlorianFuerrutter/genQC/blob/main/src/webpage/assets/qft_4qubit_circuit_15s_wpause.gif?raw=true)
+
+## Key Features and limitations
+
+- Number of parameters: **~150M**; Train steps: **~800k**
+- Unitary compilation from **3 to 5 qubits**
+- Quantum circuits up to **32 gates**
+- Training details in the [\\[paper-arxiv\\]](https://www.arxiv.org/abs/2506.01666)
+
+## Usage
+
+The pre-trained model pipeline can be loaded with [`genQC`](https://github.com/FlorianFuerrutter/genQC). First install or upgrade [`genQC`](https://github.com/FlorianFuerrutter/genQC) using
+
+``` sh
+pip install -U genQC
+```
+
+Guides on how to use this model can be found in the [\\[tutorials\\]](https://florianfuerrutter.github.io/genQC/examples/tutorials.html) on the GitHub repository of [`genQC`](https://github.com/FlorianFuerrutter/genQC).
+
+## License
+
+The model weights in this repository are licensed under the [Apache License 2.0](https://github.com/FlorianFuerrutter/genQC/blob/main/LICENSE.txt).