Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,100 +1,100 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: KittenTTS - High Quality Text-to-Speech
|
| 3 |
-
emoji: π€
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: purple
|
| 6 |
-
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
-
app_file: app_minimal.py
|
| 9 |
-
pinned: false
|
| 10 |
-
license: mit
|
| 11 |
-
---
|
| 12 |
-
|
| 13 |
-
# π€ KittenTTS - High Quality Text-to-Speech
|
| 14 |
-
|
| 15 |
-
A Hugging Face Space showcasing the KittenTTS model for high-quality text-to-speech generation.
|
| 16 |
-
|
| 17 |
-
## π Features
|
| 18 |
-
|
| 19 |
-
- **8 Different Voices**: 4 male and 4 female voices to choose from
|
| 20 |
-
- **High Quality Audio**: 24kHz sample rate for crisp, clear speech
|
| 21 |
-
- **GPU-Free**: Works without requiring a GPU
|
| 22 |
-
- **Easy-to-Use Interface**: Simple and intuitive Gradio web interface
|
| 23 |
-
- **Real-time Generation**: Fast speech synthesis with progress tracking
|
| 24 |
-
|
| 25 |
-
## π΅ Available Voices
|
| 26 |
-
|
| 27 |
-
| Voice ID | Gender | Description |
|
| 28 |
-
|----------|--------|-------------|
|
| 29 |
-
| `expr-voice-2-m` | Male | Male voice variant 2 |
|
| 30 |
-
| `expr-voice-2-f` | Female | Female voice variant 2 |
|
| 31 |
-
| `expr-voice-3-m` | Male | Male voice variant 3 |
|
| 32 |
-
| `expr-voice-3-f` | Female | Female voice variant 3 |
|
| 33 |
-
| `expr-voice-4-m` | Male | Male voice variant 4 |
|
| 34 |
-
| `expr-voice-4-f` | Female | Female voice variant 4 |
|
| 35 |
-
| `expr-voice-5-m` | Male | Male voice variant 5 |
|
| 36 |
-
| `expr-voice-5-f` | Female | Female voice variant 5 |
|
| 37 |
-
|
| 38 |
-
## π οΈ Usage
|
| 39 |
-
|
| 40 |
-
1. **Enter Text**: Type or paste your text in the input box
|
| 41 |
-
2. **Select Voice**: Choose from the dropdown menu of available voices
|
| 42 |
-
3. **Generate**: Click the "Generate Speech" button or press Enter
|
| 43 |
-
4. **Download**: Play the generated audio or download it
|
| 44 |
-
|
| 45 |
-
## π» Technical Details
|
| 46 |
-
|
| 47 |
-
- **Model**: [KittenML/kitten-tts-nano-0.1](https://huggingface.co/KittenML/kitten-tts-nano-0.1)
|
| 48 |
-
- **Sample Rate**: 24kHz
|
| 49 |
-
- **Framework**: KittenTTS
|
| 50 |
-
- **Interface**: Gradio
|
| 51 |
-
- **Audio Format**: WAV (24kHz, mono)
|
| 52 |
-
|
| 53 |
-
## π§ Local Development
|
| 54 |
-
|
| 55 |
-
To run this locally:
|
| 56 |
-
|
| 57 |
-
```bash
|
| 58 |
-
# Clone the repository
|
| 59 |
-
git clone <your-repo-url>
|
| 60 |
-
cd <your-repo-name>
|
| 61 |
-
|
| 62 |
-
# Install dependencies
|
| 63 |
-
pip install -r requirements.txt
|
| 64 |
-
|
| 65 |
-
# Run the application
|
| 66 |
-
python app.py
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
## π¦ Dependencies
|
| 70 |
-
|
| 71 |
-
- `gradio>=4.0.0` - Web interface
|
| 72 |
-
- `kittentts` - TTS framework
|
| 73 |
-
- `soundfile` - Audio file handling
|
| 74 |
-
- `numpy` - Numerical operations
|
| 75 |
-
- `torch` - PyTorch backend
|
| 76 |
-
- `torchaudio` - Audio processing
|
| 77 |
-
- `transformers` - Hugging Face transformers
|
| 78 |
-
- `accelerate` - Model acceleration
|
| 79 |
-
|
| 80 |
-
## π€ Contributing
|
| 81 |
-
|
| 82 |
-
Feel free to contribute by:
|
| 83 |
-
- Reporting bugs
|
| 84 |
-
- Suggesting new features
|
| 85 |
-
- Improving the UI
|
| 86 |
-
- Adding more voice options
|
| 87 |
-
|
| 88 |
-
## π License
|
| 89 |
-
|
| 90 |
-
This project uses the KittenTTS model. Please refer to the original model's license for usage terms.
|
| 91 |
-
|
| 92 |
-
## π Acknowledgments
|
| 93 |
-
|
| 94 |
-
- [KittenML](https://huggingface.co/KittenML) for the TTS model
|
| 95 |
-
- [Hugging Face](https://huggingface.co) for the Spaces platform
|
| 96 |
-
- [Gradio](https://gradio.app) for the web interface framework
|
| 97 |
-
|
| 98 |
-
---
|
| 99 |
-
|
| 100 |
-
**Note**: This is a demonstration of the KittenTTS model. For production use, please ensure compliance with the model's license and terms of use.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: KittenTTS - High Quality Text-to-Speech
|
| 3 |
+
emoji: π€
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 5.41.1
|
| 8 |
+
app_file: app_minimal.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
# π€ KittenTTS - High Quality Text-to-Speech
|
| 14 |
+
|
| 15 |
+
A Hugging Face Space showcasing the KittenTTS model for high-quality text-to-speech generation.
|
| 16 |
+
|
| 17 |
+
## π Features
|
| 18 |
+
|
| 19 |
+
- **8 Different Voices**: 4 male and 4 female voices to choose from
|
| 20 |
+
- **High Quality Audio**: 24kHz sample rate for crisp, clear speech
|
| 21 |
+
- **GPU-Free**: Works without requiring a GPU
|
| 22 |
+
- **Easy-to-Use Interface**: Simple and intuitive Gradio web interface
|
| 23 |
+
- **Real-time Generation**: Fast speech synthesis with progress tracking
|
| 24 |
+
|
| 25 |
+
## π΅ Available Voices
|
| 26 |
+
|
| 27 |
+
| Voice ID | Gender | Description |
|
| 28 |
+
|----------|--------|-------------|
|
| 29 |
+
| `expr-voice-2-m` | Male | Male voice variant 2 |
|
| 30 |
+
| `expr-voice-2-f` | Female | Female voice variant 2 |
|
| 31 |
+
| `expr-voice-3-m` | Male | Male voice variant 3 |
|
| 32 |
+
| `expr-voice-3-f` | Female | Female voice variant 3 |
|
| 33 |
+
| `expr-voice-4-m` | Male | Male voice variant 4 |
|
| 34 |
+
| `expr-voice-4-f` | Female | Female voice variant 4 |
|
| 35 |
+
| `expr-voice-5-m` | Male | Male voice variant 5 |
|
| 36 |
+
| `expr-voice-5-f` | Female | Female voice variant 5 |
|
| 37 |
+
|
| 38 |
+
## π οΈ Usage
|
| 39 |
+
|
| 40 |
+
1. **Enter Text**: Type or paste your text in the input box
|
| 41 |
+
2. **Select Voice**: Choose from the dropdown menu of available voices
|
| 42 |
+
3. **Generate**: Click the "Generate Speech" button or press Enter
|
| 43 |
+
4. **Download**: Play the generated audio or download it
|
| 44 |
+
|
| 45 |
+
## π» Technical Details
|
| 46 |
+
|
| 47 |
+
- **Model**: [KittenML/kitten-tts-nano-0.1](https://huggingface.co/KittenML/kitten-tts-nano-0.1)
|
| 48 |
+
- **Sample Rate**: 24kHz
|
| 49 |
+
- **Framework**: KittenTTS
|
| 50 |
+
- **Interface**: Gradio
|
| 51 |
+
- **Audio Format**: WAV (24kHz, mono)
|
| 52 |
+
|
| 53 |
+
## π§ Local Development
|
| 54 |
+
|
| 55 |
+
To run this locally:
|
| 56 |
+
|
| 57 |
+
```bash
|
| 58 |
+
# Clone the repository
|
| 59 |
+
git clone <your-repo-url>
|
| 60 |
+
cd <your-repo-name>
|
| 61 |
+
|
| 62 |
+
# Install dependencies
|
| 63 |
+
pip install -r requirements.txt
|
| 64 |
+
|
| 65 |
+
# Run the application
|
| 66 |
+
python app.py
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
## π¦ Dependencies
|
| 70 |
+
|
| 71 |
+
- `gradio>=4.0.0` - Web interface
|
| 72 |
+
- `kittentts` - TTS framework
|
| 73 |
+
- `soundfile` - Audio file handling
|
| 74 |
+
- `numpy` - Numerical operations
|
| 75 |
+
- `torch` - PyTorch backend
|
| 76 |
+
- `torchaudio` - Audio processing
|
| 77 |
+
- `transformers` - Hugging Face transformers
|
| 78 |
+
- `accelerate` - Model acceleration
|
| 79 |
+
|
| 80 |
+
## π€ Contributing
|
| 81 |
+
|
| 82 |
+
Feel free to contribute by:
|
| 83 |
+
- Reporting bugs
|
| 84 |
+
- Suggesting new features
|
| 85 |
+
- Improving the UI
|
| 86 |
+
- Adding more voice options
|
| 87 |
+
|
| 88 |
+
## π License
|
| 89 |
+
|
| 90 |
+
This project uses the KittenTTS model. Please refer to the original model's license for usage terms.
|
| 91 |
+
|
| 92 |
+
## π Acknowledgments
|
| 93 |
+
|
| 94 |
+
- [KittenML](https://huggingface.co/KittenML) for the TTS model
|
| 95 |
+
- [Hugging Face](https://huggingface.co) for the Spaces platform
|
| 96 |
+
- [Gradio](https://gradio.app) for the web interface framework
|
| 97 |
+
|
| 98 |
+
---
|
| 99 |
+
|
| 100 |
+
**Note**: This is a demonstration of the KittenTTS model. For production use, please ensure compliance with the model's license and terms of use.
|