diff --git a/README.md b/README.md index e95eb93..6eba003 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## 🚀 Overview -This project is based on [Whisper Streaming](https://github.com/ufal/whisper_streaming) and [SimulStreaming](https://github.com/ufal/SimulStreaming) (**BETA** - ultra-low latency alternative), allowing you to transcribe audio directly from your browser. WhisperLiveKit provides a complete backend solution for real-time speech transcription with a functional, simple and customizable frontend. Everything runs locally on your machine ✨ +This project is based on [Whisper Streaming](https://github.com/ufal/whisper_streaming) and [SimulStreaming](https://github.com/ufal/SimulStreaming), allowing you to transcribe audio directly from your browser. WhisperLiveKit provides a complete backend solution for real-time speech transcription with a functional, simple and customizable frontend. Everything runs locally on your machine ✨ ### 🔄 Architecture @@ -35,7 +35,7 @@ WhisperLiveKit consists of three main components: - **✅ Confidence Validation** – Immediately validate high-confidence tokens for faster inference (WhisperStreaming only) - **👁️ Buffering Preview** – Displays unvalidated transcription segments (not compatible with SimulStreaming yet) - **✒️ Punctuation-Based Speaker Splitting [BETA]** - Align speaker changes with natural sentence boundaries for more readable transcripts -- **⚡ SimulStreaming Backend [BETA]** - Ultra-low latency transcription using state-of-the-art AlignAtt policy. To use, please copy [simul_whisper](https://github.com/ufal/SimulStreaming/tree/main/simul_whisper) content into `whisperlivekit/simul_whisper` . You must comply with the [Polyform license](https://github.com/ufal/SimulStreaming/blob/main/LICENCE.txt) !! +- **⚡ SimulStreaming Backend** - Ultra-low latency transcription using state-of-the-art AlignAtt policy. To use, please copy [simul_whisper](https://github.com/ufal/SimulStreaming/tree/main/simul_whisper) content into `whisperlivekit/simul_whisper` . You must comply with the [Polyform license](https://github.com/ufal/SimulStreaming/blob/main/LICENCE.txt) !! ## 📖 Quick Start @@ -220,7 +220,7 @@ WhisperLiveKit offers extensive configuration options: |-----------|-------------|---------| | `--host` | Server host address | `localhost` | | `--port` | Server port | `8000` | -| `--model` | Whisper model size | `tiny` | +| `--model` | Whisper model size. Caution : '.en' models do not work with Simulstreaming | `tiny` | | `--language` | Source language code or `auto` | `en` | | `--task` | `transcribe` or `translate` | `transcribe` | | `--backend` | Processing backend | `faster-whisper` |