Practical overview
When it fits
Use it when an application needs a spoken activation phrase and you can provide recorded examples, install its audio dependencies, and integrate a Python library.
Who it is for
- Developers adding custom voice activation to applications
- Teams building hands-free interfaces for assistants, IoT devices, or desktop software
Documented uses
- Generate a reference file for a custom spoken hotword from WAV recordings
- Detect one or more hotwords in an audio stream
- Adjust confidence thresholds and trigger spacing for a detector
Requirements & limits
The repository specifies an Apache-2.0 license.
- The library requires Python 3.10–3.14 and manually installed PyAudio/PortAudio dependencies.
- Custom reference generation accepts WAV files only.
- The repository says detection performs best with three to four hotword samples recorded directly from the user.
- The relaxation-time setting can reduce repeated triggers from overlapping sliding windows.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Create a custom hotword reference file
Prepare a JSON reference file from recorded pronunciations for use with the detector.
Before you start
- Python 3.10–3.14
- PyAudio and its PortAudio dependency installed manually before package installation
- EfficientWord-Net installed with
pip install EfficientWord-Net - Four to ten distinct pronunciations of the chosen hotword, saved as WAV files in a folder containing no other files
Steps
Install the library with the command below.
pip install EfficientWord-NetPlace the WAV recordings in a separate folder.
Run the command below.
python -m eff_word_net.generate_referenceWhen prompted, provide the recordings folder and the output folder for the generated
_ref.jsonfile.
Expected outcome
A hotword reference JSON file that can be passed to a HotwordDetector instance.
Guide limitations
- Only WAV files are supported by the reference-generation procedure.
- This procedure prepares a reference file; microphone detection is a separate stage.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 8 October 2026
- Original website title
- Ant-Brain/EfficientWord-Net · Official homepage title · retained in its source language

