chatterbox-fp16 / README.md
prince-canuma's picture
Update README.md
4923fcc verified
---
license: apache-2.0
language:
- ar
- da
- de
- el
- en
- es
- fi
- fr
- he
- hi
- it
- ja
- ko
- ms
- nl
- no
- pl
- pt
- ru
- sv
- sw
- tr
- zh
base_model:
- ResembleAI/chatterbox
pipeline_tag: text-to-speech
library_name: mlx-audio
tags:
- text-to-speech
- speech
- speech generation
- voice cloning
- mlx
- tts
---
# mlx-community/chatterbox-fp16
This model was converted to MLX format from [`ResembleAI/chatterbox`](https://huggingface.co/ResembleAI/chatterbox) using mlx-audio version **0.2.7**.
Refer to the [original model card](https://huggingface.co/ResembleAI/chatterbox) for more details on the model.
## Use with mlx
```bash
pip install -U mlx-audio
```
### CLI Example:
```bash
python -m mlx_audio.tts.generate --model mlx-community/chatterbox-fp16 --text "Hello, this is a test."
```
### Python Example:
```python
from mlx_audio.tts.utils import load_model
from mlx_audio.tts.generate import generate_audio
model = load_model("mlx-community/chatterbox-fp16")
generate_audio(
model=model, text="Hello, this is a test.",
file_prefix="test_audio",
)
```
### Voice Cloning:
```python
from mlx_audio.tts.generate import generate_audio
generate_audio(
text="Hello, this is a test of Chatterbox TTS.",
model="mlx-community/chatterbox-fp16",
ref_audio="path_to_file.wav",
ref_text="Text transcript", # Optional
file_prefix="vc_output",
)
```
## Multilingual Quickstart
Generate speech in 23 languages by specifying the `lang_code` parameter. The model automatically handles pronunciation, intonation, and language-specific phonemes.
```python
from mlx_audio.tts.generate import generate_audio
generate_audio(
text="Olá, tudo bem?",
model="mlx-community/chatterbox-fp16",
lang_code="pt",
file_prefix="multilingual_output",
)
```
### Supported Languages
| Code | Language | Code | Language | Code | Language |
|------|------------|------|------------|------|------------|
| `ar` | Arabic | `he` | Hebrew | `no` | Norwegian |
| `da` | Danish | `hi` | Hindi | `pl` | Polish |
| `de` | German | `it` | Italian | `pt` | Portuguese |
| `el` | Greek | `ja` | Japanese | `ru` | Russian |
| `en` | English | `ko` | Korean | `sv` | Swedish |
| `es` | Spanish | `ms` | Malay | `sw` | Swahili |
| `fi` | Finnish | `nl` | Dutch | `tr` | Turkish |
| `fr` | French | `zh` | Chinese | | |