Document all three ONNX files
Browse files
README.md
CHANGED
|
@@ -9,37 +9,38 @@ library_name: openwakeword
|
|
| 9 |
pipeline_tag: audio-classification
|
| 10 |
---
|
| 11 |
|
| 12 |
-
# BMO openWakeWord
|
| 13 |
|
| 14 |
-
Custom [openWakeWord](https://github.com/dscripka/openWakeWord)
|
| 15 |
|
| 16 |
## Files
|
| 17 |
|
| 18 |
| File | Description |
|
| 19 |
|------|-------------|
|
| 20 |
-
| `hey_beemo.onnx` | Wake-word classifier
|
|
|
|
|
|
|
| 21 |
|
| 22 |
-
|
| 23 |
|
| 24 |
-
-
|
| 25 |
-
- `embedding_model.onnx`
|
| 26 |
|
| 27 |
-
|
| 28 |
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
```json
|
| 32 |
-
"model": {
|
| 33 |
-
"path": "../models/ww/hey_beemo.onnx"
|
| 34 |
-
}
|
| 35 |
```
|
| 36 |
|
| 37 |
-
|
| 38 |
|
| 39 |
-
```
|
| 40 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 41 |
```
|
| 42 |
|
| 43 |
## Training
|
| 44 |
|
| 45 |
-
|
|
|
|
| 9 |
pipeline_tag: audio-classification
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# BMO openWakeWord models
|
| 13 |
|
| 14 |
+
Custom [openWakeWord](https://github.com/dscripka/openWakeWord) pack for the wake phrase **“Hey BMO”** (trained as `hey beemo`).
|
| 15 |
|
| 16 |
## Files
|
| 17 |
|
| 18 |
| File | Description |
|
| 19 |
|------|-------------|
|
| 20 |
+
| `hey_beemo.onnx` | Wake-word classifier (“Hey BMO”) |
|
| 21 |
+
| `melspectrogram.onnx` | Shared openWakeWord mel feature model |
|
| 22 |
+
| `embedding_model.onnx` | Shared openWakeWord speech embedding model |
|
| 23 |
|
| 24 |
+
All three are required at runtime.
|
| 25 |
|
| 26 |
+
Shared feature models come from [openWakeWord-cpp](https://github.com/rhasspy/openWakeWord-cpp) / [openWakeWord](https://github.com/dscripka/openWakeWord).
|
|
|
|
| 27 |
|
| 28 |
+
## Download
|
| 29 |
|
| 30 |
+
```bash
|
| 31 |
+
hf download amrmantawi/bmo-openwakeword --local-dir models/ww
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
```
|
| 33 |
|
| 34 |
+
## local-llm config
|
| 35 |
|
| 36 |
+
```json
|
| 37 |
+
"openwakeword": {
|
| 38 |
+
"melspectrogram": { "path": "../models/ww/melspectrogram.onnx" },
|
| 39 |
+
"embedding": { "path": "../models/ww/embedding_model.onnx" },
|
| 40 |
+
"model": { "path": "../models/ww/hey_beemo.onnx" }
|
| 41 |
+
}
|
| 42 |
```
|
| 43 |
|
| 44 |
## Training
|
| 45 |
|
| 46 |
+
`hey_beemo.onnx` was trained with the openWakeWord Google Colab notebook on synthetic speech for **hey beemo**.
|