@@ -28,7 +28,48 @@ The repository follows a **package-first design**:
2828
2929---
3030
31- # Installation
31+ ## Table of Contents
32+
33+ - [ Installation] ( #installation )
34+ - [ Quick start] ( #quick-start )
35+
36+ - [ Variational quantum classifier] ( #variational-quantum-classifier )
37+ - [ Variational quantum regression] ( #variational-quantum-regression )
38+ - [ Quantum convolutional neural network] ( #quantum-convolutional-neural-network )
39+ - [ Quantum autoencoder] ( #quantum-autoencoder )
40+ - [ Quantum kernel classifier] ( #quantum-kernel-classifier )
41+ - [ Trainable quantum kernel] ( #trainable-quantum-kernel-kernel-target-alignment )
42+ - [ Quantum metric learning] ( #quantum-metric-learning )
43+
44+ - [ Noise-aware execution (finite shots)] ( #noise-aware-execution-finite-shots )
45+ - [ Benchmark framework] ( #benchmark-framework )
46+ - [ Model-specific configuration] ( #model-specific-configuration )
47+ - [ Classical baselines] ( #classical-baselines )
48+ - [ Command line interface] ( #command-line-interface )
49+ - [ Documentation] ( #documentation )
50+ - [ Repository structure] ( #repository-structure )
51+ - [ Design principles] ( #design-principles )
52+
53+ - [ Package-first architecture] ( #package-first-architecture )
54+ - [ Deterministic workflows] ( #deterministic-workflows )
55+ - [ Minimal abstractions] ( #minimal-abstractions )
56+
57+ - [ Current algorithms] ( #current-algorithms )
58+
59+ - [ Variational quantum classifier] ( #variational-quantum-classifier-1 )
60+ - [ Variational quantum regression] ( #variational-quantum-regression-1 )
61+ - [ Quantum kernel classifier] ( #quantum-kernel-classifier-1 )
62+ - [ Trainable quantum kernel] ( #trainable-quantum-kernel-1 )
63+ - [ Quantum metric learning] ( #quantum-metric-learning-1 )
64+
65+ - [ Development workflow] ( #development-workflow )
66+ - [ Support development] ( #support-development )
67+ - [ Author] ( #author )
68+ - [ License] ( #license )
69+
70+ ---
71+
72+ ## Installation
3273
3374Clone and install in editable mode:
3475
@@ -52,9 +93,9 @@ Requirements:
5293
5394---
5495
55- # Quick start
96+ ## Quick start
5697
57- ## Variational quantum classifier
98+ ### Variational quantum classifier
5899
59100``` python
60101from qml.classifiers import run_vqc
@@ -69,7 +110,7 @@ result = run_vqc(
69110
70111---
71112
72- ## Variational quantum regression
113+ ### Variational quantum regression
73114
74115``` python
75116from qml.regression import run_vqr
@@ -84,7 +125,7 @@ result = run_vqr(
84125
85126---
86127
87- ## Quantum convolutional neural network
128+ ### Quantum convolutional neural network
88129
89130``` python
90131from qml.qcnn import run_qcnn
@@ -104,7 +145,7 @@ Learns a small hierarchical quantum classifier using:
104145
105146---
106147
107- ## Quantum autoencoder
148+ ### Quantum autoencoder
108149
109150``` python
110151from qml.autoencoder import run_quantum_autoencoder
@@ -125,7 +166,7 @@ Learns a compression map for structured four-qubit state families using:
125166
126167---
127168
128- ## Quantum kernel classifier
169+ ### Quantum kernel classifier
129170
130171``` python
131172from qml.kernel_methods import run_quantum_kernel_classifier
@@ -138,7 +179,7 @@ result = run_quantum_kernel_classifier(
138179
139180---
140181
141- ## Trainable quantum kernel (kernel-target alignment)
182+ ### Trainable quantum kernel (kernel-target alignment)
142183
143184``` python
144185from qml.trainable_kernels import run_trainable_quantum_kernel_classifier
@@ -152,7 +193,7 @@ result = run_trainable_quantum_kernel_classifier(
152193
153194---
154195
155- ## Quantum metric learning
196+ ### Quantum metric learning
156197
157198``` python
158199from qml.metric_learning import run_quantum_metric_learner
@@ -180,7 +221,7 @@ metric-learning workflow returns a typed dataclass.
180221
181222---
182223
183- # Noise-aware execution (finite shots)
224+ ## Noise-aware execution (finite shots)
184225
185226Quantum circuits can be evaluated either analytically or with finite sampling.
186227
@@ -215,7 +256,7 @@ All workflows remain deterministic when a fixed seed is provided.
215256
216257---
217258
218- # Benchmark framework
259+ ## Benchmark framework
219260
220261Benchmark utilities compare quantum and classical models across multiple seeds.
221262
@@ -239,7 +280,7 @@ result = compare_classification_models(
239280
240281---
241282
242- ## Model-specific configuration
283+ ### Model-specific configuration
243284
244285Benchmarks accept per-model kwargs:
245286
@@ -269,7 +310,7 @@ Result structure remains consistent across models.
269310
270311---
271312
272- # Classical baselines
313+ ## Classical baselines
273314
274315Included reference models:
275316
@@ -282,7 +323,7 @@ These provide performance context for quantum models.
282323
283324---
284325
285- # Command line interface
326+ ## Command line interface
286327
287328Run workflows directly:
288329
@@ -319,7 +360,7 @@ CLI outputs include:
319360
320361---
321362
322- # Documentation
363+ ## Documentation
323364
324365Core documentation:
325366
@@ -347,7 +388,7 @@ Example notebooks:
347388
348389---
349390
350- # Repository structure
391+ ## Repository structure
351392
352393```
353394qml/
@@ -432,9 +473,9 @@ images/
432473
433474---
434475
435- # Design principles
476+ ## Design principles
436477
437- ## Package-first architecture
478+ ### Package-first architecture
438479
439480Core implementations live in:
440481
@@ -446,7 +487,7 @@ Notebooks import public APIs rather than defining circuits inline.
446487
447488---
448489
449- ## Deterministic workflows
490+ ### Deterministic workflows
450491
451492Reproducibility is prioritised:
452493
@@ -458,7 +499,7 @@ Reproducibility is prioritised:
458499
459500---
460501
461- ## Minimal abstractions
502+ ### Minimal abstractions
462503
463504Shared infrastructure intentionally remains lightweight:
464505
@@ -469,9 +510,9 @@ Shared infrastructure intentionally remains lightweight:
469510
470511---
471512
472- # Current algorithms
513+ ## Current algorithms
473514
474- ## Variational quantum classifier
515+ ### Variational quantum classifier
475516
476517Binary classification using:
477518
@@ -481,7 +522,7 @@ Binary classification using:
481522
482523---
483524
484- ## Variational quantum regression
525+ ### Variational quantum regression
485526
486527Continuous prediction using:
487528
@@ -491,7 +532,7 @@ Continuous prediction using:
491532
492533---
493534
494- ## Quantum kernel classifier
535+ ### Quantum kernel classifier
495536
496537Support vector machine using quantum feature maps:
497538
504545
505546---
506547
507- ## Trainable quantum kernel
548+ ### Trainable quantum kernel
508549
509550Kernel alignment objective:
510551
@@ -525,7 +566,7 @@ where:
525566
526567---
527568
528- ## Quantum metric learning
569+ ### Quantum metric learning
529570
530571Supervised embedding optimisation using contrastive loss:
531572
@@ -552,7 +593,7 @@ Supports:
552593
553594---
554595
555- # Development workflow
596+ ## Development workflow
556597
557598Run tests:
558599
@@ -575,6 +616,18 @@ python -m qml
575616
576617---
577618
619+ ## Support development
620+
621+ If this project is useful for research, learning, or experimentation, you can support continued development via GitHub Sponsors:
622+
623+ https://github.com/sponsors/SidRichardsQuantum
624+
625+ Sponsorship supports continued work on open-source implementations of quantum machine learning models, including improvements to documentation, reproducible experiments, benchmark utilities, and example workflows.
626+
627+ Support helps maintain accessible implementations of variational quantum models, quantum kernels, and hybrid quantum–classical learning tools.
628+
629+ ---
630+
578631## Author
579632
580633Sid Richards
0 commit comments