amrmantawi commited on
Commit
58eb940
·
verified ·
1 Parent(s): 9742f14

Document all three ONNX files

Browse files
Files changed (1) hide show
  1. README.md +18 -17
README.md CHANGED
@@ -9,37 +9,38 @@ library_name: openwakeword
9
  pipeline_tag: audio-classification
10
  ---
11
 
12
- # BMO openWakeWord model
13
 
14
- Custom [openWakeWord](https://github.com/dscripka/openWakeWord) model 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 head (ONNX) |
 
 
21
 
22
- Also requires the shared openWakeWord feature models at runtime:
23
 
24
- - `melspectrogram.onnx`
25
- - `embedding_model.onnx`
26
 
27
- (from [openWakeWord](https://github.com/dscripka/openWakeWord) / [openWakeWord-cpp](https://github.com/rhasspy/openWakeWord-cpp))
28
 
29
- ## Usage with local-llm
30
-
31
- ```json
32
- "model": {
33
- "path": "../models/ww/hey_beemo.onnx"
34
- }
35
  ```
36
 
37
- Or download from this repo:
38
 
39
- ```bash
40
- hf download amrmantawi/bmo-openwakeword hey_beemo.onnx --local-dir models/ww
 
 
 
 
41
  ```
42
 
43
  ## Training
44
 
45
- Trained with the openWakeWord Google Colab automatic training notebook on synthetic speech for the phrase **hey beemo**.
 
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**.