RealTimeSTT-fork/tests/README.md

OpenWakeWord Test

1. Set up the openwakeword test project:

   mkdir samantha_wake_word && cd samantha_wake_word
   curl -O https://raw.githubusercontent.com/KoljaB/RealtimeSTT/master/tests/openwakeword_test.py
   curl -L https://huggingface.co/KoljaB/SamanthaOpenwakeword/resolve/main/suh_mahn_thuh.onnx -o suh_mahn_thuh.onnx
   curl -L https://huggingface.co/KoljaB/SamanthaOpenwakeword/resolve/main/suh_man_tuh.onnx -o suh_man_tuh.onnx
   

   Ensure you have curl installed for downloading files. If not, you can manually download the files from the provided URLs.

   1. Create and activate a virtual environment: bash python -m venv venv
      

   • For Windows:

     venv\Scripts\activate
     

     • For Unix-like systems (Linux/macOS): bash source venv/bin/activate

   • For macOS: Use python3 instead of python and pip3 instead of pip if needed.

2. Install dependencies:

   python -m pip install --upgrade pip
   python -m pip install RealtimeSTT
   python -m pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu121
   

   The PyTorch installation command includes CUDA 12.1 support. Adjust if a different version is required.

   1. Run the test script: bash python openwakeword_test.py
      

On the very first start some models for openwakeword are downloaded.