admin-valentin/WhisperLiveKit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

typos

Browse source
This commit is contained in:
Quentin Fuxa 2025-04-09 10:14:23 +02:00
parent c791b1e125
commit 23e41f993f
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -252,12 +252,12 @@ To deploy WhisperLiveKit in production:
### 🐋 Docker ### 🐋 Docker
A basic Dockerfile is provided which allows re-use of python package installation options. See below useage examples: A basic Dockerfile is provided which allows re-use of Python package installation options. See below usage examples:
***NOTE:** For **larger** models, ensure that your **docker runtime** has enough **memory** available.* **NOTE:** For **larger** models, ensure that your **docker runtime** has enough **memory** available.
#### All defaults #### All defaults
- Create a reuseable image with only the basics and then run as a named container. - Create a reusable image with only the basics and then run as a named container:
```bash ```bash
docker build -t whisperlivekit-defaults . docker build -t whisperlivekit-defaults .
docker create --gpus all --name whisperlivekit -p 8000:8000 whisperlivekit-defaults docker create --gpus all --name whisperlivekit -p 8000:8000 whisperlivekit-defaults
@ -267,17 +267,17 @@ docker start -i whisperlivekit
> **Note**: If you're running on a system without NVIDIA GPU support (such as Mac with Apple Silicon or any system without CUDA capabilities), you need to **remove the `--gpus all` flag** from the `docker create` command. Without GPU acceleration, transcription will use CPU only, which may be significantly slower. Consider using small models for better performance on CPU-only systems. > **Note**: If you're running on a system without NVIDIA GPU support (such as Mac with Apple Silicon or any system without CUDA capabilities), you need to **remove the `--gpus all` flag** from the `docker create` command. Without GPU acceleration, transcription will use CPU only, which may be significantly slower. Consider using small models for better performance on CPU-only systems.
#### Customization #### Customization
- Customise the container options. - Customize the container options:
```bash ```bash
docker build -t whisperlivekit-defaults . docker build -t whisperlivekit-defaults .
docker create --gpus all --name whisperlivekit-base -p 8000:8000 whisperlivekit-defaults --model base docker create --gpus all --name whisperlivekit-base -p 8000:8000 whisperlivekit-defaults --model base
docker start -i whisperlivekit-base docker start -i whisperlivekit-base
``` ```
- `--build-arg` Options - `--build-arg` Options:
- `EXTRAS="whisper-timestamped"` - Add extras to the image's installation (no spaces). Remember to set necessary container options! - `EXTRAS="whisper-timestamped"` - Add extras to the image's installation (no spaces). Remember to set necessary container options!
- `HF_PRECACHE_DIR=./.cache/` - Pre-load a model cache for faster first-time start - `HF_PRECACHE_DIR="./.cache/"` - Pre-load a model cache for faster first-time start
- `HF_TOKEN=./token` - Add your Hugging Face Hub access token to download gated models - `HF_TOKEN="./token"` - Add your Hugging Face Hub access token to download gated models
## 🔮 Use Cases ## 🔮 Use Cases