Jarbas commited on
Commit
a873fa8
·
verified ·
1 Parent(s): 1201150

README: the plugin downloads models from this repository; Common Voice attribution

Browse files
Files changed (1) hide show
  1. README.md +7 -3
README.md CHANGED
@@ -54,8 +54,10 @@ its own ONNX metadata (`wake_word`, `pretrained_featurizer`, `default_threshold`
54
  ## Use with OpenVoiceOS
55
 
56
  The models run in [ovos-ww-plugin-wakeforge](https://github.com/OpenVoiceOS/ovos-ww-plugin-wakeforge), which
57
- bundles them together with both WakeHuBERT featurizers, so nothing else is downloaded. Install the plugin and name
58
- the model in `mycroft.conf`:
 
 
59
 
60
  ```bash
61
  pip install --pre ovos-ww-plugin-wakeforge
@@ -204,4 +206,6 @@ the calibrated scale. The fitted slope and offset are in each model's `calib_a`
204
 
205
  Apache-2.0. The featurizer, [TigreGotico/wakehubert-tiny](https://huggingface.co/TigreGotico/wakehubert-tiny), is
206
  Apache-2.0. The `synthetic-wakeword-*` and `not-wake-words-speech-en` datasets are CC BY 4.0; LibriSpeech is
207
- CC BY 4.0; AudioSet labels are CC BY 4.0 and its audio comes from YouTube videos under their uploaders' terms.
 
 
 
54
  ## Use with OpenVoiceOS
55
 
56
  The models run in [ovos-ww-plugin-wakeforge](https://github.com/OpenVoiceOS/ovos-ww-plugin-wakeforge), which
57
+ downloads them from this repository on first use, at a pinned revision, checks each file against its `sha256` in
58
+ `models.json`, and keeps them in the Hugging Face cache; the featurizer comes from
59
+ [TigreGotico/wakehubert-tiny](https://huggingface.co/TigreGotico/wakehubert-tiny) the same way. Install the plugin
60
+ and name the model in `mycroft.conf`:
61
 
62
  ```bash
63
  pip install --pre ovos-ww-plugin-wakeforge
 
206
 
207
  Apache-2.0. The featurizer, [TigreGotico/wakehubert-tiny](https://huggingface.co/TigreGotico/wakehubert-tiny), is
208
  Apache-2.0. The `synthetic-wakeword-*` and `not-wake-words-speech-en` datasets are CC BY 4.0; LibriSpeech is
209
+ CC BY 4.0; AudioSet labels are CC BY 4.0 and its audio comes from YouTube videos under their uploaders' terms. The
210
+ voice-conversion folders of `synthetic-wakeword-computer` and `synthetic-wakeword-hey_mycroft` take their voices from
211
+ Mozilla Common Voice contributors, through the MLCommons Multilingual Spoken Words Corpus (CC BY 4.0).