prince-canuma commited on
Commit
9617d61
·
verified ·
1 Parent(s): a12811b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +80 -6
README.md CHANGED
@@ -1,9 +1,31 @@
1
  ---
2
  license: apache-2.0
3
  language:
4
- - en
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  base_model:
6
- - ResembleAI/chatterbox-turbo
7
  pipeline_tag: text-to-speech
8
  library_name: mlx-audio
9
  tags:
@@ -13,18 +35,70 @@ tags:
13
  - voice cloning
14
  - mlx
15
  - tts
16
- - mlx
17
  ---
18
 
19
  # mlx-community/chatterbox-8bit
20
- This model was converted to MLX format from [`mlx-community/chatterbox-fp16`](https://huggingface.co/mlx-community/chatterbox-fp16) using mlx-audio version **0.2.8**.
21
- Refer to the [original model card](https://huggingface.co/mlx-community/chatterbox-fp16) for more details on the model.
 
22
  ## Use with mlx
23
 
24
  ```bash
25
  pip install -U mlx-audio
26
  ```
27
 
 
28
  ```bash
29
- python -m mlx_audio.tts.generate --model mlx-community/chatterbox-8bit --text "Describe this image."
30
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  language:
4
+ - ar
5
+ - da
6
+ - de
7
+ - el
8
+ - en
9
+ - es
10
+ - fi
11
+ - fr
12
+ - he
13
+ - hi
14
+ - it
15
+ - ja
16
+ - ko
17
+ - ms
18
+ - nl
19
+ - no
20
+ - pl
21
+ - pt
22
+ - ru
23
+ - sv
24
+ - sw
25
+ - tr
26
+ - zh
27
  base_model:
28
+ - ResembleAI/chatterbox
29
  pipeline_tag: text-to-speech
30
  library_name: mlx-audio
31
  tags:
 
35
  - voice cloning
36
  - mlx
37
  - tts
 
38
  ---
39
 
40
  # mlx-community/chatterbox-8bit
41
+ This model was converted to MLX format from [`ResembleAI/chatterbox`](https://huggingface.co/ResembleAI/chatterbox) using mlx-audio version **0.2.7**.
42
+ Refer to the [original model card](https://huggingface.co/ResembleAI/chatterbox) for more details on the model.
43
+
44
  ## Use with mlx
45
 
46
  ```bash
47
  pip install -U mlx-audio
48
  ```
49
 
50
+ ### CLI Example:
51
  ```bash
52
+ python -m mlx_audio.tts.generate --model mlx-community/chatterbox-8bit --text "Hello, this is a test."
53
  ```
54
+ ### Python Example:
55
+ ```python
56
+ from mlx_audio.tts.utils import load_model
57
+ from mlx_audio.tts.generate import generate_audio
58
+ model = load_model("mlx-community/chatterbox-8bit")
59
+ generate_audio(
60
+ model=model, text="Hello, this is a test.",
61
+ file_prefix="test_audio",
62
+ )
63
+ ```
64
+
65
+ ### Voice Cloning:
66
+ ```python
67
+ from mlx_audio.tts.generate import generate_audio
68
+
69
+ generate_audio(
70
+ text="Hello, this is a test of Chatterbox TTS.",
71
+ model="mlx-community/chatterbox-8bit",
72
+ ref_audio="path_to_file.wav",
73
+ ref_text="Text transcript", # Optional
74
+ file_prefix="vc_output",
75
+ )
76
+ ```
77
+
78
+ ## Multilingual Quickstart
79
+
80
+ Generate speech in 23 languages by specifying the `lang_code` parameter. The model automatically handles pronunciation, intonation, and language-specific phonemes.
81
+
82
+ ```python
83
+ from mlx_audio.tts.generate import generate_audio
84
+
85
+ generate_audio(
86
+ text="Olá, tudo bem?",
87
+ model="mlx-community/chatterbox-8bit",
88
+ lang_code="pt",
89
+ file_prefix="multilingual_output",
90
+ )
91
+ ```
92
+
93
+ ### Supported Languages
94
+
95
+ | Code | Language | Code | Language | Code | Language |
96
+ |------|------------|------|------------|------|------------|
97
+ | `ar` | Arabic | `he` | Hebrew | `no` | Norwegian |
98
+ | `da` | Danish | `hi` | Hindi | `pl` | Polish |
99
+ | `de` | German | `it` | Italian | `pt` | Portuguese |
100
+ | `el` | Greek | `ja` | Japanese | `ru` | Russian |
101
+ | `en` | English | `ko` | Korean | `sv` | Swedish |
102
+ | `es` | Spanish | `ms` | Malay | `sw` | Swahili |
103
+ | `fi` | Finnish | `nl` | Dutch | `tr` | Turkish |
104
+ | `fr` | French | `zh` | Chinese | | |