Skip to content

Latest commit

 

History

History

whisperService

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
faster-whisper.py
faster-whisper.py
 
 
requirements.txt
requirements.txt
 
 
setup.cmd
setup.cmd
 
 
setup.sh
setup.sh
 
 

README.md

Local whisper service

This project runs a Faster Whisper model locally, exposing a local REST endpoint. You can launch the service by running e.g. python faster-whisper.py.

Setup

Prerequisites

  • Windows
    • FFMpeg - you can run winget install ffmpeg to install the package
  • MaxOS
    • brew install portaudio - needed to install pyaudio

Install

Option 1: Batch file

  • Windows:
  • MacOS/Linux:
    • Run source setup.sh

Option 2: Manual steps

  • Create and activate a python virtual environment.
  • pip config --site set global.extra-index-url https://download.pytorch.org/whl/cu121
  • pip install -r requirements.txt

Verify Setup

Test if the installation worked by starting the backend python faster-whisper.py.

Connecting to the running service

You can connect to the whisper service using the example "whisperClient" project in the ts/examples folder. To use it:

  • Go to the repo's ts/examples/whisperClient folder
  • Build the project using pnpm run build
  • Start the web UI using pnpm run start

This web client will capture audio from microphone, send to the local service for transcription and show the result.