hasarinduperera commited on
Commit
a7790b0
·
verified ·
1 Parent(s): c9245b6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +58 -8
README.md CHANGED
@@ -1,10 +1,60 @@
1
- ---
2
- title: README
3
- emoji: 🌍
4
- colorFrom: purple
5
- colorTo: blue
6
- sdk: static
7
- pinned: false
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
1
+ ---
2
+ title: QuPrep
3
+ emoji:
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ pinned: true
8
+ license: apache-2.0
9
+ thumbnail: >-
10
+ https://cdn-uploads.huggingface.co/production/uploads/6390b2d90aea681d3f3fd6b7/wZZeHlOwjImqGL6xBG65U.png
11
+ ---
12
+
13
+ # QuPrep — Quantum Data Preparation
14
+
15
+ **The missing preprocessing layer between classical datasets and quantum computing.**
16
+
17
+ QuPrep converts classical tabular datasets into quantum-circuit-ready format. It sits between your data and whichever quantum framework you use — Qiskit, PennyLane, Cirq, TKET, Amazon Braket, Q#, or IQM — without locking you into any one of them.
18
+
19
+ Think of it as the **pandas of quantum data preparation**: focused, composable, framework-agnostic.
20
+
21
+ ```
22
+ CSV / DataFrame / NumPy → QuPrep → circuit-ready output for your framework
23
+ ```
24
+
25
+ ## What it does
26
+
27
+ - **11 encoding methods** — Angle, Amplitude, Basis, IQP, Entangled Angle, Data Re-uploading, Hamiltonian, ZZFeatureMap, PauliFeatureMap, Random Fourier, Tensor Product
28
+ - **8 export targets** — Qiskit, PennyLane, Cirq, TKET, Amazon Braket, Q#, IQM, OpenQASM 3.0
29
+ - **Intelligent recommendation** — dataset-aware encoding selection with ranked alternatives
30
+ - **Hardware-aware reduction** — auto-reduces features to fit a backend's qubit budget
31
+ - **QUBO / Ising** — formulate and solve combinatorial optimization problems (Max-Cut, TSP, Knapsack, Portfolio, and more)
32
+ - **Plugin registry** — register custom encoders and exporters that work with the same one-liner API
33
+
34
+ ## Install
35
+
36
+ ```bash
37
+ pip install quprep
38
+ ```
39
+
40
+ ## Quick example
41
+
42
+ ```python
43
+ import quprep as qd
44
+
45
+ result = qd.prepare("data.csv", encoding="angle", framework="qiskit")
46
+ print(result.circuit) # qiskit.QuantumCircuit
47
+ print(result.cost) # gate count, depth, NISQ safety
48
+ ```
49
+
50
+ ## Links
51
+
52
+ - 📦 PyPI: [pypi.org/project/quprep](https://pypi.org/project/quprep/)
53
+ - 📖 Docs: [docs.quprep.org](https://docs.quprep.org)
54
+ - 🌐 Website: [quprep.org](https://quprep.org)
55
+ - 💻 Source: [github.com/quprep/quprep](https://github.com/quprep/quprep)
56
+ - 🎯 Demo: [huggingface.co/spaces/quprep/demo](https://huggingface.co/spaces/quprep/demo)
57
+
58
  ---
59
 
60
+ *Apache 2.0 license · Python 3.10 · Independent research project*