austinroy commited on
Commit
ef07291
·
verified ·
1 Parent(s): e1b70b9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -95
README.md CHANGED
@@ -1,95 +0,0 @@
1
- ---
2
- license: mit
3
- language:
4
- - en
5
- tags:
6
- - text-to-speech
7
- - speech generation
8
- - voice-cloning
9
- pipeline_tag: text-to-speech
10
- library_name: chatterbox
11
- ---
12
-
13
- <img width="800" alt="cb-big2" src="https://github.com/user-attachments/assets/bd8c5f03-e91d-4ee5-b680-57355da204d1" />
14
-
15
- <h1 style="font-size: 32px">Chatterbox TTS</h1>
16
-
17
- <div style="display: flex; align-items: center; gap: 12px">
18
- <a href="https://resemble-ai.github.io/chatterbox_demopage/">
19
- <img src="https://img.shields.io/badge/listen-demo_samples-blue" alt="Listen to Demo Samples" />
20
- </a>
21
- <a href="https://huggingface.co/spaces/ResembleAI/Chatterbox">
22
- <img src="https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm.svg" alt="Open in HF Spaces" />
23
- </a>
24
- <a href="https://podonos.com/resembleai/chatterbox">
25
- <img src="https://static-public.podonos.com/badges/insight-on-pdns-sm-dark.svg" alt="Insight on Podos" />
26
- </a>
27
- </div>
28
-
29
- <div style="display: flex; align-items: center; gap: 8px;">
30
- <span style="font-style: italic;white-space: pre-wrap">Made with ❤️ by</span>
31
- <img width="100" alt="resemble-logo-horizontal" src="https://github.com/user-attachments/assets/35cf756b-3506-4943-9c72-c05ddfa4e525" />
32
- </div>
33
-
34
-
35
- We're excited to introduce Chatterbox, [Resemble AI's](https://resemble.ai) first production-grade open source TTS model. Licensed under MIT, Chatterbox has been benchmarked against leading closed-source systems like ElevenLabs, and is consistently preferred in side-by-side evaluations.
36
-
37
- Whether you're working on memes, videos, games, or AI agents, Chatterbox brings your content to life. It's also the first open source TTS model to support **emotion exaggeration control**, a powerful feature that makes your voices stand out. Try it now on our [Hugging Face Gradio app.](https://huggingface.co/spaces/ResembleAI/Chatterbox)
38
-
39
- If you like the model but need to scale or tune it for higher accuracy, check out our competitively priced TTS service (<a href="https://resemble.ai">link</a>). It delivers reliable performance with ultra-low latency of sub 200ms—ideal for production use in agents, applications, or interactive media.
40
-
41
- # Key Details
42
- - SoTA zeroshot TTS
43
- - 0.5B Llama backbone
44
- - Unique exaggeration/intensity control
45
- - Ultra-stable with alignment-informed inference
46
- - Trained on 0.5M hours of cleaned data
47
- - Watermarked outputs
48
- - Easy voice conversion script
49
- - [Outperforms ElevenLabs](https://podonos.com/resembleai/chatterbox)
50
-
51
- # Tips
52
- - **General Use (TTS and Voice Agents):**
53
- - The default settings (`exaggeration=0.5`, `cfg=0.5`) work well for most prompts.
54
- - If the reference speaker has a fast speaking style, lowering `cfg` to around `0.3` can improve pacing.
55
-
56
- - **Expressive or Dramatic Speech:**
57
- - Try lower `cfg` values (e.g. `~0.3`) and increase `exaggeration` to around `0.7` or higher.
58
- - Higher `exaggeration` tends to speed up speech; reducing `cfg` helps compensate with slower, more deliberate pacing.
59
-
60
-
61
- # Installation
62
- ```
63
- pip install chatterbox-tts
64
- ```
65
-
66
-
67
- # Usage
68
- ```python
69
- import torchaudio as ta
70
- from chatterbox.tts import ChatterboxTTS
71
-
72
- model = ChatterboxTTS.from_pretrained(device="cuda")
73
-
74
- text = "Ezreal and Jinx teamed up with Ahri, Yasuo, and Teemo to take down the enemy's Nexus in an epic late-game pentakill."
75
- wav = model.generate(text)
76
- ta.save("test-1.wav", wav, model.sr)
77
-
78
- # If you want to synthesize with a different voice, specify the audio prompt
79
- AUDIO_PROMPT_PATH="YOUR_FILE.wav"
80
- wav = model.generate(text, audio_prompt_path=AUDIO_PROMPT_PATH)
81
- ta.save("test-2.wav", wav, model.sr)
82
- ```
83
- See `example_tts.py` for more examples.
84
-
85
- # Acknowledgements
86
- - [Cosyvoice](https://github.com/FunAudioLLM/CosyVoice)
87
- - [HiFT-GAN](https://github.com/yl4579/HiFTNet)
88
- - [Llama 3](https://github.com/meta-llama/llama3)
89
-
90
- # Built-in PerTh Watermarking for Responsible AI
91
-
92
- Every audio file generated by Chatterbox includes [Resemble AI's Perth (Perceptual Threshold) Watermarker](https://github.com/resemble-ai/perth) - imperceptible neural watermarks that survive MP3 compression, audio editing, and common manipulations while maintaining nearly 100% detection accuracy.
93
-
94
- # Disclaimer
95
- Don't use this model to do bad things. Prompts are sourced from freely available data on the internet.