Commit @942e287e8372828d89c4c37d387f9990e76a6d3f - yjyoon/whisper_streaming

Quentin Fuxa 2024-12-19

Update README.md

@942e287e8372828d89c4c37d387f9990e76a6d3f

5be3058

942e287

README.md

--- README.md

+++ README.md


 
 2. **Buffering Indication**: Improves streaming display by showing the current processing status, providing users with immediate feedback.
 
-3. **Javascript Client implementation**: Functionnal and minimalist MediaRecorder implementation that can be copied on your client side
+3. **Javascript Client implementation**: Functionnal and minimalist MediaRecorder implementation that can be copied on your client side.
 
 4. **MLX Whisper backend**: Integrates the alternative backend option MLX Whisper, optimized for efficient speech recognition on Apple silicon.
 

 
 ### How to Launch the Server
 
-1. **Install Dependencies**:
+1. **Dependencies**:
+
+- Install required dependences :
 
     ```bash
-    pip install -r requirements.txt
+    # Whisper streaming required dependencies
+    pip install librosa soundfile
+
+    # Whisper streaming web required dependencies
+    pip install fastapi ffmpeg
     ```
-2. Install a whisper backend among:
+- Install at least one whisper backend among:
 
- ```
-whisper
-whisper-timestamped
-faster-whisper (faster backend on NVIDIA GPU)
-mlx-whisper (faster backend on Apple Silicon)
+    ```
+   whisper
+   whisper-timestamped
+   faster-whisper (faster backend on NVIDIA GPU)
+   mlx-whisper (faster backend on Apple Silicon)
+   
+   and torch if you want to use VAC (Voice Activity Controller)
+   ```
+- Optionnal dependencies
 
-and torch if you want to use VAC (Voice Activity Controller)
-```
+    ```
+    # If you want to use VAC (Voice Activity Controller)
+    torch
+   
+    # If you choose sentences as buffer trimming strategy
+    mosestokenizer
+    wtpsplit
+    tokenize_uk # If you work with Ukrainian text
+
+    # If you want to run the server using uvicorn (recommended)
+    uvicorn
+    ```
 
 
 3. **Run the FastAPI Server**:

Add a comment

Open 0
Closed 0

List

...	...	@@ -6,7 +6,7 @@
6	6
7	7	2. Buffering Indication: Improves streaming display by showing the current processing status, providing users with immediate feedback.
8	8
9		-3. Javascript Client implementation: Functionnal and minimalist MediaRecorder implementation that can be copied on your client side
	9	+3. Javascript Client implementation: Functionnal and minimalist MediaRecorder implementation that can be copied on your client side.
10	10
11	11	4. MLX Whisper backend: Integrates the alternative backend option MLX Whisper, optimized for efficient speech recognition on Apple silicon.
12	12
...	...	@@ -25,21 +25,41 @@
25	25
26	26	### How to Launch the Server
27	27
28		-1. Install Dependencies:
	28	+1. Dependencies:
	29	+
	30	+- Install required dependences :
29	31
30	32	```bash
31		- pip install -r requirements.txt
	33	+ # Whisper streaming required dependencies
	34	+ pip install librosa soundfile
	35	+
	36	+ # Whisper streaming web required dependencies
	37	+ pip install fastapi ffmpeg
32	38	```
33		-2. Install a whisper backend among:
	39	+- Install at least one whisper backend among:
34	40
35		- ```
36		-whisper
37		-whisper-timestamped
38		-faster-whisper (faster backend on NVIDIA GPU)
39		-mlx-whisper (faster backend on Apple Silicon)
	41	+ ```
	42	+ whisper
	43	+ whisper-timestamped
	44	+ faster-whisper (faster backend on NVIDIA GPU)
	45	+ mlx-whisper (faster backend on Apple Silicon)
	46	+
	47	+ and torch if you want to use VAC (Voice Activity Controller)
	48	+ ```
	49	+- Optionnal dependencies
40	50
41		-and torch if you want to use VAC (Voice Activity Controller)
42		-```
	51	+ ```
	52	+ # If you want to use VAC (Voice Activity Controller)
	53	+ torch
	54	+
	55	+ # If you choose sentences as buffer trimming strategy
	56	+ mosestokenizer
	57	+ wtpsplit
	58	+ tokenize_uk # If you work with Ukrainian text
	59	+
	60	+ # If you want to run the server using uvicorn (recommended)
	61	+ uvicorn
	62	+ ```
43	63
44	64
45	65	3. Run the FastAPI Server:

Delete comment