1.0.9 โข Published 7 months ago
@p0llen/wakeword-react v1.0.9
@p0llen/wakeword-react
Status: ๐ง In Testing License: MIT
Free, open-source wake-word detection package using PyTorch, with an associated npm package for React-based integration.
Includes CLI tools, real-time microphone access, and GPU-accelerated training capabilities.
๐ง How It Works
Install the Python backend (wakeword-detector
) for model training and ONNX export. Then, install this React package for in-browser wakeword detection.
When sound input matches the trained model, the React component will be notified โ enabling real-time browser-based wakeword detection.
๐ Usage
import { useWakeword, WakewordDemo } from "@p0llen/wakeword-react";
function App() {
return <WakewordDemo />;
}
๐ฅ Features
- ๐ค Real-time wakeword detection in the browser
- โ๏ธ React component (
useWakeword
) for easy integration - ๐ง ONNX model inference with
onnxruntime-web
- ๐๏ธ Adjustable confidence thresholds and visual feedback
- ๐ Fully customizable โ bring your own wakeword
- ๐งช Demo UI (
WakewordDemo
component) included for instant testing
๐ฆ Installation
1. Backend (Python)
Install the backend model trainer and exporter:
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple wakeword-detector
๐ Requirements
- eact 17 or 18+
- Modern browser (Chrome, Edge, Brave, etc.)
- ONNX model trained using wakeword-detector
๐ค Contributing Found a bug or want to suggest a feature? Open an issue or PR. Contributions welcome!