Update README.md
Browse files
README.md
CHANGED
@@ -1,6 +1,58 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: mit
|
3 |
+
title: KKR2
|
4 |
+
sdk: gradio
|
5 |
+
colorFrom: blue
|
6 |
+
colorTo: green
|
7 |
+
---
|
8 |
+
# Text-to-Speech App with Kokoro-82M-ONNX
|
9 |
+
|
10 |
+
This is a Gradio-based text-to-speech (TTS) app that uses the [Kokoro-82M-ONNX](https://huggingface.co/onnx-community/Kokoro-82M-ONNX) model from Hugging Face. The app allows you to generate speech from text with multiple speaker options and download the resulting audio file.
|
11 |
+
|
12 |
+
## Features
|
13 |
+
|
14 |
+
- **Text-to-Speech Conversion**: Convert any input text into speech.
|
15 |
+
- **Multiple Speakers**: Choose from different speaker voices.
|
16 |
+
- **Download Audio**: Download the generated speech as a `.wav` file.
|
17 |
+
|
18 |
+
## How to Use
|
19 |
+
|
20 |
+
1. **Enter Text**: Type or paste your text into the input box.
|
21 |
+
2. **Select Speaker**: Choose a speaker from the dropdown menu.
|
22 |
+
3. **Generate Speech**: Click the "Submit" button to generate the speech.
|
23 |
+
4. **Download Audio**: Once the speech is generated, you can listen to it or download the `.wav` file.
|
24 |
+
|
25 |
+
## Example Inputs
|
26 |
+
|
27 |
+
- **Text**: "Hello, welcome to the text-to-speech app!"
|
28 |
+
- **Speaker**: "Speaker 1"
|
29 |
+
|
30 |
+
## Requirements
|
31 |
+
|
32 |
+
The app requires the following Python packages:
|
33 |
+
|
34 |
+
- `onnxruntime`
|
35 |
+
- `torch`
|
36 |
+
- `gradio`
|
37 |
+
- `scipy`
|
38 |
+
- `numpy`
|
39 |
+
- `huggingface_hub`
|
40 |
+
|
41 |
+
These dependencies are automatically installed when the Space is built.
|
42 |
+
|
43 |
+
## Model Details
|
44 |
+
|
45 |
+
The app uses the [Kokoro-82M-ONNX](https://huggingface.co/onnx-community/Kokoro-82M-ONNX) model, a lightweight and efficient text-to-speech model in ONNX format. The model supports multiple speakers and generates high-quality speech.
|
46 |
+
|
47 |
+
## Limitations
|
48 |
+
|
49 |
+
- The model may not handle very long texts efficiently.
|
50 |
+
- Speaker options are limited to the embeddings supported by the model.
|
51 |
+
|
52 |
+
## Feedback and Contributions
|
53 |
+
|
54 |
+
If you encounter any issues or have suggestions for improvement, please open an issue on the [GitHub repository](https://github.com/your-repo-link) or contact me directly.
|
55 |
+
|
56 |
+
---
|
57 |
+
|
58 |
+
Enjoy using the app! 🎉
|