Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,69 @@
+---
+library_name: pytorch
+tags:
+  - audio-to-audio
+  - speech-enhancement
+  - acoustic-echo-cancellation
+  - noise-suppression
+  - ggml
+license: apache-2.0
+---
+
+# LocalVQE — Local Voice Quality Enhancement
+
+Real-time joint acoustic echo cancellation (AEC), noise suppression (NS), and
+dereverberation for 16 kHz speech. Based on *LocalVQE: Real Time Deep Voice
+Quality Enhancement* (Indenbom et al., Interspeech 2023,
+[arXiv:2306.03177](https://arxiv.org/abs/2306.03177)), redesigned for
+quantization-aware CPU inference with DCT-II analysis/synthesis in place of
+STFT.
+
+Project source: <https://github.com/richiejp/LocalVQE>
+
+## Files
+
+| File | Size | Description |
+|---|---|---|
+| `baseline.pt` | 11 MB | DNS5-trained baseline (val_loss 0.0213, ERLE 14.9 dB). |
+| `finetune.pt` | 11 MB | AEC fine-tune (1 epoch on AEC Challenge synthetic set). |
+| `localvqe-baseline.gguf` | 5 MB | GGML F32 export of `baseline.pt` (BN-folded, DCT weights embedded). |
+| `localvqe-finetune.gguf` | 5 MB | GGML F32 export of `finetune.pt`. |
+
+## Usage (GGML / C++ / Go)
+
+```bash
+# Build the ggml binary
+cd ggml && cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build -j
+
+# Run inference on a 16 kHz WAV pair
+./build/bin/localvqe localvqe-baseline.gguf \
+    --in-wav mic.wav ref.wav --out-wav enhanced.wav
+```
+
+Per-frame wall time on Zen4 (24 threads): ~1.66 ms (9.6× realtime at
+16 kHz / 256-sample hop).
+
+## Architecture
+
+| Component | Value |
+|-----------|-------|
+| Sample rate | 16 kHz |
+| Analysis basis | DCT-II (Conv1d filterbank, 512 filters, stride 256, frozen) |
+| Mic encoder | 5 blocks: 2 → 64 → 128 → 128 → 128 → 128 |
+| Far-end encoder | 2 blocks: 2 → 32 → 128 |
+| AlignBlock | Cross-attention soft delay, d_max=32 (320 ms), h=32 |
+| Bottleneck | GRU(1152 → 576) + Linear(576 → 1152) |
+| Decoder | 5 sub-pixel conv + BN blocks: 128 → 128 → 128 → 64 → 64 |
+| CCM | 27-ch → 3×3 complex convolving mask (real-valued arithmetic) |
+| Parameters | ~8.0 M |
+
+## Citation
+
+```bibtex
+@inproceedings{indenbom2023localvqe,
+  title={{LocalVQE}: Real Time Deep Voice Quality Enhancement},
+  author={Indenbom, Evgenii and Beresford, Nicolae-C{\u a}t{\u a}lin and Adiban, Mohammad and Klej{\v c}ek, Ji{\v r}{\' i}},
+  booktitle={Interspeech},
+  year={2023}
+}
+```