Skip to content

Commit

Permalink
Update requirements for live captions demo install
Browse files Browse the repository at this point in the history
The package `numba` is needed explicitly to mitigate failing to download and build `llvmlite` package.  Add README test notes and fix links in table of contents.
  • Loading branch information
guynich committed Dec 5, 2024
1 parent a1d77cc commit 316b231
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
7 changes: 5 additions & 2 deletions demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ Moonshine ASR models.

- [Moonshine Demos](#moonshine-demos)
- [Demo: Running in the browser](#demo-running-in-the-browser)
- [Installation](#installation)
- [Demo: Live captioning from microphone input](#demo-live-captioning-from-microphone-input)
- [Installation.](#installation)
- [Installation](#installation-1)
- [0. Setup environment](#0-setup-environment)
- [1. Clone the repo and install extra dependencies](#1-clone-the-repo-and-install-extra-dependencies)
- [Ubuntu: Install PortAudio](#ubuntu-install-portaudio)
- [Running the demo](#running-the-demo)
- [Script notes](#script-notes)
- [Speech truncation and hallucination](#speech-truncation-and-hallucination)
Expand Down Expand Up @@ -56,11 +58,12 @@ https://github.com/user-attachments/assets/aa65ef54-d4ac-4d31-864f-222b0e6ccbd3

The [`moonshine-onnx/live_captions.py`](/demo/moonshine-onnx/live_captions.py) script contains a demo of live captioning from microphone input, built on Moonshine. The script runs the Moonshine ONNX model on segments of speech detected in the microphone signal using a voice activity detector called [`silero-vad`](https://github.com/snakers4/silero-vad). The script prints scrolling text or "live captions" assembled from the model predictions to the console.

The following steps have been tested in a `uv` (v0.4.25) virtual environment on these platforms:
The following steps have been tested in `uv` virtual environments on these platforms:

- macOS 14.1 on a MacBook Pro M3
- Ubuntu 22.04 VM on a MacBook Pro M2
- Ubuntu 24.04 VM on a MacBook Pro M2
- Debian 12.8 (64-bit) on a Raspberry Pi 5 (Model B Rev 1.0)

## Installation

Expand Down
1 change: 1 addition & 0 deletions demo/moonshine-onnx/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
numba
silero_vad
sounddevice
useful-moonshine-onnx@git+https://[email protected]/usefulsensors/moonshine.git#subdirectory=moonshine-onnx

0 comments on commit 316b231

Please sign in to comment.