Browse Source

openwakeword support

Kolja Beigel 10 months ago
parent
commit
2dbee255f4
3 changed files with 4 additions and 4 deletions
  1. 1 1
      README.md
  2. 2 3
      RealtimeSTT/audio_recorder.py
  3. 1 0
      requirements.txt

+ 1 - 1
README.md

@@ -343,7 +343,7 @@ When you initialize the `AudioToTextRecorder` class, you have various options to
 
 - **openwakeword_model_paths** (str, default=None): Comma-separated paths to model files for the openwakeword library. These paths point to custom models that can be used for wake word detection when the openwakeword library is selected as the wakeword_backend.
 
-- **openwakeword_inference_framework** (str, default="onnx"): Specifies the inference framework to use with the openwakeword library. Supported frameworks include 'onnx' for using the Open Neural Network Exchange format, which can provide performance optimizations over other formats.
+- **openwakeword_inference_framework** (str, default="onnx"): Specifies the inference framework to use with the openwakeword library. Can be either 'onnx' for Open Neural Network Exchange format or 'tflite' for TensorFlow Lite.
 
 - **wake_words** (str, default=""): Initiate recording when using the 'pvporcupine' wakeword backend. Multiple wake words can be provided as a comma-separated string. Supported wake words are: alexa, americano, blueberry, bumblebee, computer, grapefruits, grasshopper, hey google, hey siri, jarvis, ok google, picovoice, porcupine, terminator. For the 'openwakeword' backend, wake words are automatically extracted from the provided model files, so specifying them here is not necessary.
 

+ 2 - 3
RealtimeSTT/audio_recorder.py

@@ -261,9 +261,8 @@ class AudioToTextRecorder:
             openwakeword library is selected as the wakeword_backend.
         - openwakeword_inference_framework (str, default="onnx"): Specifies
             the inference framework to use with the openwakeword library.
-            Supported frameworks include 'onnx' for using the Open Neural Network
-            Exchange format, which can provide performance optimizations over
-            other formats.
+            Can be either 'onnx' for Open Neural Network Exchange format 
+            or 'tflite' for TensorFlow Lite.
         - wake_words (str, default=""): Comma-separated string of wake words to
             initiate recording when using the 'pvporcupine' wakeword backend.
             Supported wake words include: 'alexa', 'americano', 'blueberry',

+ 1 - 0
requirements.txt

@@ -7,3 +7,4 @@ torch==2.3.0
 torchaudio==2.3.0
 scipy==1.12.0
 websockets==v12.0
+openwakeword==0.6.0