jay2219 commited on
Commit
b901bfa
·
1 Parent(s): e0787c1

doc: usage guide addition

Browse files
Files changed (1) hide show
  1. README.md +50 -0
README.md CHANGED
@@ -28,6 +28,9 @@ This dataset is a remastered version prepared using [Adaption's](https://adaptio
28
 
29
  This dataset contains pairs of abstract OpenQASM 2.0 quantum circuits and their hardware-compliant compiled versions. Each sample specifies a target qubit topology (e.g., Star, Ring, Linear, Grid, HeavyHex) and coupling map constraints. The compiled outputs include necessary SWAP gates inserted to satisfy physical connectivity requirements while minimizing circuit depth.
30
 
 
 
 
31
  ### Dataset size
32
 
33
  There are 15,000 data points in this dataset. This is an instruction tuning dataset.
@@ -56,3 +59,50 @@ The final quality is B, with a relative quality improvement of -26.0%.
56
 
57
  - **Percentile Chart:**
58
  <img src="https://proteus-prod-public.s3.us-east-1.amazonaws.com/temp/52761e13-0dea-4c29-a368-9cbac7fec0fe.png" alt="Percentile Chart" style="max-width: 50%; display: block; margin-left: auto; margin-right: auto;" />
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
  This dataset contains pairs of abstract OpenQASM 2.0 quantum circuits and their hardware-compliant compiled versions. Each sample specifies a target qubit topology (e.g., Star, Ring, Linear, Grid, HeavyHex) and coupling map constraints. The compiled outputs include necessary SWAP gates inserted to satisfy physical connectivity requirements while minimizing circuit depth.
30
 
31
+ > **Dataset Motto:**
32
+ > *"Embedding physical spatial graph calculus into LLM weight space to eliminate graph hallucinations and enable deterministic quantum hardware circuit routing."*
33
+
34
  ### Dataset size
35
 
36
  There are 15,000 data points in this dataset. This is an instruction tuning dataset.
 
59
 
60
  - **Percentile Chart:**
61
  <img src="https://proteus-prod-public.s3.us-east-1.amazonaws.com/temp/52761e13-0dea-4c29-a368-9cbac7fec0fe.png" alt="Percentile Chart" style="max-width: 50%; display: block; margin-left: auto; margin-right: auto;" />
62
+
63
+ ---
64
+
65
+ ### Usage & Quickstart
66
+
67
+ Load the dataset directly using the Hugging Face `datasets` library:
68
+
69
+ ```python
70
+ from datasets import load_dataset
71
+
72
+ # Load the instruction-tuning dataset
73
+ dataset = load_dataset("jay2219/quantum-circuit-routing")
74
+
75
+ # Inspect a sample training pair
76
+ sample = dataset["train"][0]
77
+ print("System Role:\n", sample["messages"][0]["content"])
78
+ print("User Prompt (Abstract QASM & Topology):\n", sample["messages"][1]["content"])
79
+ print("Assistant Response (Routed Compliant QASM):\n", sample["messages"][2]["content"])
80
+ ```
81
+
82
+ ---
83
+
84
+ ### Data Schema & Fields
85
+
86
+ Each record follows the standard OpenAI Chat format:
87
+ - **`messages[0]` (`system`)**: Enforces deterministic quantum hardware compilation role and strict OpenQASM output requirements.
88
+ - **`messages[1]` (`user`)**: Specifies the physical hardware topology, qubit count, explicit coupling map (valid edge list), hardware constraints, and input abstract OpenQASM 2.0.
89
+ - **`messages[2]` (`assistant`)**: Compiled OpenQASM 2.0 code containing minimal SWAP gate insertions to satisfy physical coupling map adjacency constraints.
90
+
91
+ ---
92
+
93
+ ### Hardware Topologies Covered
94
+
95
+ The 15,000 instruction-tuning samples span 5 distinct physical quantum hardware architectures:
96
+ 1. **Linear:** 1D line chain topology (e.g. 5–15 qubits).
97
+ 2. **Ring:** 1D closed-loop ring topology.
98
+ 3. **Star:** Central hub routing graph (all peripheral qubits connect through hub node 0).
99
+ 4. **Grid:** 2D rectangular lattice QPU connectivity graphs (e.g. 2x2 up to 5x3).
100
+ 5. **HeavyHex:** IBM Heavy-Hex lattice architecture.
101
+
102
+ ---
103
+
104
+ ### Associated Models & Evaluation Benchmarks
105
+
106
+ - **Fine-Tuned Model:** [`jay2219/Q-Route-70B`](https://huggingface.co/jay2219/Q-Route-70B)
107
+ - **Held-Out Evaluation Benchmark:** [`jay2219/Q-Route-Benchmark`](https://huggingface.co/datasets/jay2219/Q-Route-Benchmark) (100 non-overlapping evaluation circuits with 0% data contamination)
108
+