mirror of
https://github.com/PierrunoYT/Kokoro-TTS-Local.git
synced 2025-01-27 02:30:25 +03:00
Update README: Add current status and call for help
This commit is contained in:
34
README.md
34
README.md
@@ -1,8 +1,18 @@
|
||||
# Kokoro TTS
|
||||
|
||||
⚠️ **CURRENT STATUS: NOT WORKING - HELP NEEDED** ⚠️
|
||||
|
||||
This project is currently experiencing issues with the espeak-ng integration and phonemizer library. We're looking for contributors who can help fix these problems.
|
||||
|
||||
A local implementation of the Kokoro Text-to-Speech system, based on the [Kokoro-82M model](https://huggingface.co/hexgrad/Kokoro-82M).
|
||||
|
||||
## Features
|
||||
## Known Issues
|
||||
|
||||
- Phonemizer library fails to detect espeak-ng even when properly installed
|
||||
- Integration between Python phonemizer and espeak-ng needs fixing
|
||||
- Model loading process needs debugging
|
||||
|
||||
## Features (When Working)
|
||||
|
||||
- High-quality English text-to-speech synthesis
|
||||
- Multiple voice styles
|
||||
@@ -33,21 +43,25 @@ source venv/bin/activate # Linux/Mac
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Run the demo script:
|
||||
```bash
|
||||
python tts_demo.py
|
||||
```
|
||||
|
||||
This will generate an audio file with sample text. You can modify the text, style, and speed parameters in the script.
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `tts_demo.py` - Demo script showing basic usage
|
||||
- `models.py` - Model implementation and utilities
|
||||
- `requirements.txt` - Python dependencies
|
||||
|
||||
## How to Contribute
|
||||
|
||||
If you have experience with:
|
||||
- Python text-to-speech systems
|
||||
- espeak-ng integration
|
||||
- phonemizer library
|
||||
- PyTorch model deployment
|
||||
|
||||
Please consider contributing to fix the current issues. You can:
|
||||
1. Fork the repository
|
||||
2. Create a branch for your fixes
|
||||
3. Submit a pull request
|
||||
|
||||
## Credits
|
||||
|
||||
- Original model: [hexgrad/Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M)
|
||||
|
||||
Reference in New Issue
Block a user