Skip to content

Commit fdd9e44

Browse files
committed
docs: update readme
1 parent 6ec6713 commit fdd9e44

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
11
# Speech Box
22

33
A text-to-speech and speech-to-text server compatible with the OpenAI API, powered by backend support from Whisper, FunASR, Bark, and CosyVoice.
4+
5+
## Installation
6+
7+
You can install the project using pip:
8+
9+
```bash
10+
pip install vox-box
11+
```
12+
13+
## Usage
14+
15+
```
16+
vox-box start --model --huggingface-repo-id Systran/faster-whisper-small --data-dir ./cache/data-dir --host 0.0.0.0 --port 80
17+
```
18+
19+
### Options
20+
- -d, --debug: Enable debug mode.
21+
- --host: Host to bind the server to. Default is 0.0.0.0.
22+
- --port: Port to bind the server to. Default is 80.
23+
- --model: model path.
24+
- --device: Binding device, e.g., cuda:0. Default is cpu.
25+
- --huggingface-repo-id: Huggingface repo id for the model.
26+
- --model-scope-model-id: Model scope model id for the model.
27+
- --data-dir: Directory to store downloaded model data. Default is OS specific.
28+
29+
## Supported Backends
30+
31+
The project supports the following backends:
32+
33+
- FunASR
34+
- Faster-Whisper
35+
- Bark
36+
- CosyVoice
37+
38+
All models supported by these backends can be deployed with this project.
39+
40+
### Supported Models
41+
42+
- [FunASR](https://github.com/modelscope/FunASR?tab=readme-ov-file#model-zoo)
43+
- [Faster-Whisper](https://huggingface.co/Systran)
44+
- [Bark](https://huggingface.co/suno)
45+
- [CosyVoice](https://modelscope.cn/collections/CosyVoice-1a4baea39a135)

0 commit comments

Comments
 (0)