livekit-wakeword-bench 0.1.0__tar.gz

livekit_wakeword_bench-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+.cache/
+out/
+results/
+.env.local
+.env
+*.egg-info/
+src/livekit_wakeword_bench/_version.py

livekit_wakeword_bench-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 LiveKit, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

livekit_wakeword_bench-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.5
+Name: livekit-wakeword-bench
+Version: 0.1.0
+Summary: Generate wake word datasets (LiveKit Inference TTS + real noise) and benchmark any wake word model
+Project-URL: Homepage, https://github.com/livekit/wakeword-bench
+Project-URL: Repository, https://github.com/livekit/wakeword-bench
+Project-URL: Dataset, https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit
+Author-email: Binh Pham <binh.pham@livekit.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,dataset,keyword-spotting,livekit,tts,wake-word
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.14.5
+Requires-Dist: datasets>=3
+Requires-Dist: huggingface-hub>=2.2.0
+Requires-Dist: livekit-agents>=1.2
+Requires-Dist: numpy>=2.5.4
+Requires-Dist: pandas>=3.0.6
+Requires-Dist: pronouncing>=0.3.0
+Requires-Dist: pyarrow>=26.0.0
+Requires-Dist: pydantic>=2.14.1
+Requires-Dist: python-dotenv>=1.2.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=15.0.0
+Requires-Dist: scipy>=1.18.1
+Requires-Dist: soundfile>=0.14.0
+Requires-Dist: tqdm>=4.70.1
+Requires-Dist: typer>=0.27.3
+Requires-Dist: wordfreq>=3.1.1
+Provides-Extra: torch
+Requires-Dist: torch>=2.2; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# LiveKit WakeWord Bench
+
+Generate a benchmark or training dataset for your wake word, with labeled speech, near-miss phrases and realistic audio conditions. Use the benchmark to measure any detector against the same test set.
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Dataset](https://img.shields.io/badge/%F0%9F%A4%97-dataset-yellow)](https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit)
+
+## Quick start
+
+Requires Python 3.12+ and the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/). Generation uses LiveKit Inference credits.
+
+```bash
+pip install livekit-wakeword-bench
+lk cloud auth
+lk app env -w
+
+# Generate train, validation and test splits for your phrase.
+lkwb generate "hey jarvis" --size small -o out/hey_jarvis
+lkwb verify out/hey_jarvis
+```
+
+For a benchmark only, add `--split test`; for training data only, add `--split train`. Use `--size tiny` for a smoke test. Choose `--plan` to match your account (`build` by default). TTS capacity is shared with production agents: leave room for them with a lower `--set tts.concurrency=N`.
+
+For unusual names, run `lkwb init "your wake word"` to create a pronunciation config. See [Generate](docs/generate.md) for sizes, pronunciation, custom settings and outputs.
+
+## What gets generated
+
+The generator combines phoneme-guided TTS with recorded noise, room responses and speech. Each clip has 16 kHz audio, a label, phrase timing and metadata describing its voice and audio conditions.
+
+| Sample | Contents | What it tests |
+|---|---|---|
+| Positive | Your wake word alone or in a sentence, with varied voices, delivery and speaking speed | Does the model detect the intended phrase? |
+| Adversarial negative | Similar-sounding substitutions, partial phrases and your custom hard negatives | Does it reject near misses? |
+| Ordinary speech | Synthesized sentences without the wake word | Does unrelated conversation trigger it? |
+| Recorded speech | Segments from real speech corpora | Does natural speech trigger it? |
+| Noise only | Background sounds without the target phrase | Do environmental sounds trigger it? |
+
+Only positives have label `1`; all negatives have label `0`. Category counts depend on the size and split: training presets contain positives, adversarial negatives and synthesized speech. See the [exact sample counts](docs/generate.md#choose-sample-counts).
+
+Positive and adversarial phrases are isolated or placed before/after surrounding speech (`p_carrier=0.35` by default). Near misses are generated from phonetic similarity; add known confusions with `hard_negatives`.
+
+## Which conditions are covered
+
+Validation and test clips sample combinations of these conditions. They are not an exhaustive test of every combination.
+
+| Condition | Default coverage |
+|---|---|
+| Background noise | Clean background plus five SNR buckets, from quiet (20–30 dB) to noise louder than speech (−5–0 dB) |
+| Competing speech | A second voice 0–20 dB quieter; party scenes with 2–4 talkers and crowd noise |
+| Rooms | Recorded room impulse responses for reverberation |
+| Device effects | EQ, band limiting, clipping, codec compression and varying levels |
+| Voice and delivery | Multiple TTS providers, voices and accent labels; speaking speed 0.85–1.2× |
+| Phrasing | Isolated phrases, phrases in sentences and phonetically similar negatives |
+
+For example, the same wake word can be detected alone and missed with a competing speaker:
+
+<img alt="A wake word is detected alone but missed with a competing voice" src="assets/teaser.svg">
+
+Training clips are stored clean by default so you can [add fresh effects while training](docs/train.md). Test voices, noise, rooms and recorded speakers are held apart from training. Never train on the test split or test sources. Some source corpora restrict commercial use; see [sources and licenses](docs/reference.md#audio-sources).
+
+Tune the recipe with YAML or `--set key=value`. For example, generate training data with more competing speech:
+
+```bash
+lkwb generate "hey jarvis" --size small --split train -o out/train_talkers \
+    --set splits.train.augment=true \
+    --set augment.p_interferer=0.6 \
+    --set augment.clean_weight=0.2
+```
+
+Run `lkwb knobs` for all settings. TTS is cached, so changing only augmentation reuses synthesized speech.
+
+## How models are evaluated
+
+**The headline score is recall at the lowest tested threshold with no more than 0.5 false positives per hour (FPPH).** Higher is better; change the target with `--score-fpph`.
+
+| Criterion | Measurement |
+|---|---|
+| Wake word detection | Recall: fraction of positives detected between phrase onset and 1 second after phrase end |
+| Background false alarms | Triggers per hour of ordinary speech, recorded speech and noise; counted triggers are at least 2 seconds apart by default |
+| Near-miss rejection | Fraction of adversarial clips that trigger; reported separately, excluded from FPPH |
+| Response time | Trigger time relative to phrase end; negative latency means early detection |
+| Compute cost | Processing time / audio duration; use `--workers 1` |
+
+Reports break results down by noise, competing speech, room, device effects, voice, accent and phrasing, with 95% confidence intervals. Breakdowns use `--threshold` (default 0.5), which may differ from the headline score's threshold.
+
+Synthesized positives do not establish recall on real users. Accent labels come from TTS metadata. Treat confidence intervals wider than about 0.2 as weak evidence; rare false alarms need many hours of negative audio.
+
+## Evaluate on your dataset
+
+For a livekit-wakeword v2 streaming model:
+
+```bash
+pip install livekit-wakeword
+lkwb bench path/to/your_model.onnx --data out/hey_jarvis --limit 1000
+```
+
+Open `results/report.html` for charts and playable failures. Remove `--limit` for a full run before reporting results. Compare models using the same dataset, split, filters and limit.
+
+Other models use the [custom detector interface](docs/benchmark.md#your-own-model). Existing datasets need no LiveKit credentials. Omitting `--data` uses the public [Hey LiveKit dataset](https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit), which is an example benchmark for that phrase.
+
+## Documentation
+
+| Task | Guide |
+|---|---|
+| Generate and check your benchmark or dataset | [Generate](docs/generate.md) |
+| Look up sample fields, sources and generation settings | [Reference](docs/reference.md) |
+| Load, augment or export training data | [Train](docs/train.md) |
+| Evaluate detectors and compare results | [Benchmark](docs/benchmark.md) |
+| Contribute or release | [Development](docs/development.md) |
+
+For coding agents, see [AGENTS.md](AGENTS.md).

livekit_wakeword_bench-0.1.0/README.md

@@ -0,0 +1,112 @@
+# LiveKit WakeWord Bench
+
+Generate a benchmark or training dataset for your wake word, with labeled speech, near-miss phrases and realistic audio conditions. Use the benchmark to measure any detector against the same test set.
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Dataset](https://img.shields.io/badge/%F0%9F%A4%97-dataset-yellow)](https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit)
+
+## Quick start
+
+Requires Python 3.12+ and the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/). Generation uses LiveKit Inference credits.
+
+```bash
+pip install livekit-wakeword-bench
+lk cloud auth
+lk app env -w
+
+# Generate train, validation and test splits for your phrase.
+lkwb generate "hey jarvis" --size small -o out/hey_jarvis
+lkwb verify out/hey_jarvis
+```
+
+For a benchmark only, add `--split test`; for training data only, add `--split train`. Use `--size tiny` for a smoke test. Choose `--plan` to match your account (`build` by default). TTS capacity is shared with production agents: leave room for them with a lower `--set tts.concurrency=N`.
+
+For unusual names, run `lkwb init "your wake word"` to create a pronunciation config. See [Generate](docs/generate.md) for sizes, pronunciation, custom settings and outputs.
+
+## What gets generated
+
+The generator combines phoneme-guided TTS with recorded noise, room responses and speech. Each clip has 16 kHz audio, a label, phrase timing and metadata describing its voice and audio conditions.
+
+| Sample | Contents | What it tests |
+|---|---|---|
+| Positive | Your wake word alone or in a sentence, with varied voices, delivery and speaking speed | Does the model detect the intended phrase? |
+| Adversarial negative | Similar-sounding substitutions, partial phrases and your custom hard negatives | Does it reject near misses? |
+| Ordinary speech | Synthesized sentences without the wake word | Does unrelated conversation trigger it? |
+| Recorded speech | Segments from real speech corpora | Does natural speech trigger it? |
+| Noise only | Background sounds without the target phrase | Do environmental sounds trigger it? |
+
+Only positives have label `1`; all negatives have label `0`. Category counts depend on the size and split: training presets contain positives, adversarial negatives and synthesized speech. See the [exact sample counts](docs/generate.md#choose-sample-counts).
+
+Positive and adversarial phrases are isolated or placed before/after surrounding speech (`p_carrier=0.35` by default). Near misses are generated from phonetic similarity; add known confusions with `hard_negatives`.
+
+## Which conditions are covered
+
+Validation and test clips sample combinations of these conditions. They are not an exhaustive test of every combination.
+
+| Condition | Default coverage |
+|---|---|
+| Background noise | Clean background plus five SNR buckets, from quiet (20–30 dB) to noise louder than speech (−5–0 dB) |
+| Competing speech | A second voice 0–20 dB quieter; party scenes with 2–4 talkers and crowd noise |
+| Rooms | Recorded room impulse responses for reverberation |
+| Device effects | EQ, band limiting, clipping, codec compression and varying levels |
+| Voice and delivery | Multiple TTS providers, voices and accent labels; speaking speed 0.85–1.2× |
+| Phrasing | Isolated phrases, phrases in sentences and phonetically similar negatives |
+
+For example, the same wake word can be detected alone and missed with a competing speaker:
+
+<img alt="A wake word is detected alone but missed with a competing voice" src="assets/teaser.svg">
+
+Training clips are stored clean by default so you can [add fresh effects while training](docs/train.md). Test voices, noise, rooms and recorded speakers are held apart from training. Never train on the test split or test sources. Some source corpora restrict commercial use; see [sources and licenses](docs/reference.md#audio-sources).
+
+Tune the recipe with YAML or `--set key=value`. For example, generate training data with more competing speech:
+
+```bash
+lkwb generate "hey jarvis" --size small --split train -o out/train_talkers \
+    --set splits.train.augment=true \
+    --set augment.p_interferer=0.6 \
+    --set augment.clean_weight=0.2
+```
+
+Run `lkwb knobs` for all settings. TTS is cached, so changing only augmentation reuses synthesized speech.
+
+## How models are evaluated
+
+**The headline score is recall at the lowest tested threshold with no more than 0.5 false positives per hour (FPPH).** Higher is better; change the target with `--score-fpph`.
+
+| Criterion | Measurement |
+|---|---|
+| Wake word detection | Recall: fraction of positives detected between phrase onset and 1 second after phrase end |
+| Background false alarms | Triggers per hour of ordinary speech, recorded speech and noise; counted triggers are at least 2 seconds apart by default |
+| Near-miss rejection | Fraction of adversarial clips that trigger; reported separately, excluded from FPPH |
+| Response time | Trigger time relative to phrase end; negative latency means early detection |
+| Compute cost | Processing time / audio duration; use `--workers 1` |
+
+Reports break results down by noise, competing speech, room, device effects, voice, accent and phrasing, with 95% confidence intervals. Breakdowns use `--threshold` (default 0.5), which may differ from the headline score's threshold.
+
+Synthesized positives do not establish recall on real users. Accent labels come from TTS metadata. Treat confidence intervals wider than about 0.2 as weak evidence; rare false alarms need many hours of negative audio.
+
+## Evaluate on your dataset
+
+For a livekit-wakeword v2 streaming model:
+
+```bash
+pip install livekit-wakeword
+lkwb bench path/to/your_model.onnx --data out/hey_jarvis --limit 1000
+```
+
+Open `results/report.html` for charts and playable failures. Remove `--limit` for a full run before reporting results. Compare models using the same dataset, split, filters and limit.
+
+Other models use the [custom detector interface](docs/benchmark.md#your-own-model). Existing datasets need no LiveKit credentials. Omitting `--data` uses the public [Hey LiveKit dataset](https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit), which is an example benchmark for that phrase.
+
+## Documentation
+
+| Task | Guide |
+|---|---|
+| Generate and check your benchmark or dataset | [Generate](docs/generate.md) |
+| Look up sample fields, sources and generation settings | [Reference](docs/reference.md) |
+| Load, augment or export training data | [Train](docs/train.md) |
+| Evaluate detectors and compare results | [Benchmark](docs/benchmark.md) |
+| Contribute or release | [Development](docs/development.md) |
+
+For coding agents, see [AGENTS.md](AGENTS.md).

livekit_wakeword_bench-0.1.0/docs/README.md

@@ -0,0 +1,13 @@
+# Documentation
+
+Start with the [README](../README.md) to generate a dataset and understand its samples, audio conditions and evaluation criteria.
+
+| Task | Guide |
+|---|---|
+| Generate a benchmark or training dataset for your phrase | [Generate](generate.md) |
+| Look up sample fields, audio sources and settings | [Reference](reference.md) |
+| Load, augment and export training data | [Train](train.md) |
+| Evaluate a detector on your dataset and compare results | [Benchmark](benchmark.md) |
+| Set up development and publish releases | [Development](development.md) |
+
+Keep the generated test set fixed and separate from training when comparing models.

livekit_wakeword_bench-0.1.0/pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+name = "livekit-wakeword-bench"
+dynamic = ["version"]
+description = "Generate wake word datasets (LiveKit Inference TTS + real noise) and benchmark any wake word model"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Binh Pham", email = "binh.pham@livekit.io" }]
+requires-python = ">=3.12"
+keywords = ["wake-word", "keyword-spotting", "benchmark", "dataset", "tts", "livekit"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Sound/Audio :: Speech",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "aiohttp>=3.14.5",
+    "datasets>=3",
+    "huggingface-hub>=2.2.0",
+    "livekit-agents>=1.2",
+    "numpy>=2.5.4",
+    "pandas>=3.0.6",
+    "pronouncing>=0.3.0",
+    "pyarrow>=26.0.0",
+    "pydantic>=2.14.1",
+    "python-dotenv>=1.2.4",
+    "pyyaml>=6.0.3",
+    "rich>=15.0.0",
+    "scipy>=1.18.1",
+    "soundfile>=0.14.0",
+    "tqdm>=4.70.1",
+    "typer>=0.27.3",
+    "wordfreq>=3.1.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/livekit/wakeword-bench"
+Repository = "https://github.com/livekit/wakeword-bench"
+Dataset = "https://huggingface.co/datasets/binhpham/wakeword-bench-hey-livekit"
+
+[project.scripts]
+lkwb = "livekit_wakeword_bench.cli:app"
+
+[project.optional-dependencies]
+torch = ["torch>=2.2"]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/livekit_wakeword_bench/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/livekit_wakeword_bench"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/livekit_wakeword_bench", "README.md", "LICENSE"]
+
+[dependency-groups]
+dev = [
+    "faster-whisper>=1.2.1",
+    "matplotlib>=3.11.2",
+    "pytest>=9.1.1",
+    "ruff>=0.17.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

livekit_wakeword_bench-0.1.0/src/livekit_wakeword_bench/__init__.py

@@ -0,0 +1,36 @@
+"""Generate wake word datasets and benchmark any wake word model."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("livekit-wakeword-bench")
+except PackageNotFoundError:  # running from a source tree without an install
+    __version__ = "0.0.0"
+
+from .bench import BenchConfigRun, BenchResult, benchmark, compare, evaluate, run_detector
+from .config import BenchConfig, load_config, make_config
+from .dataset import DEFAULT_DATASET
+from .detectors import Detector, Prediction, SlidingWindowDetector, load_detector
+from .generate import generate
+from .loader import Sample, WakeWordData
+
+__all__ = [
+    "__version__",
+    "DEFAULT_DATASET",
+    "BenchConfig",
+    "BenchConfigRun",
+    "BenchResult",
+    "Detector",
+    "Prediction",
+    "Sample",
+    "SlidingWindowDetector",
+    "WakeWordData",
+    "benchmark",
+    "compare",
+    "evaluate",
+    "generate",
+    "load_config",
+    "load_detector",
+    "make_config",
+    "run_detector",
+]

livekit_wakeword_bench-0.1.0/src/livekit_wakeword_bench/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None