JamboGPT Bot commited on
Commit Β·
a2c7513
1
Parent(s): deb4070
Update README with Space metadata
Browse files
README.md
CHANGED
|
@@ -1,137 +1,46 @@
|
|
| 1 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
|
| 6 |
|
| 7 |
## Features
|
| 8 |
|
| 9 |
-
- π€
|
| 10 |
-
- π
|
| 11 |
-
- β‘
|
| 12 |
-
- π
|
| 13 |
-
- π― **Easy to Use**: Simple Gradio interface
|
| 14 |
-
- π± **Web-Based**: Access from any browser
|
| 15 |
|
| 16 |
## Supported Languages
|
| 17 |
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
| Kikuyu | ki | Bantu language spoken in central Kenya |
|
| 22 |
-
| English | eng | English language |
|
| 23 |
-
|
| 24 |
-
## Installation
|
| 25 |
-
|
| 26 |
-
### Requirements
|
| 27 |
-
- Python 3.8+
|
| 28 |
-
- CUDA 11.8+ (optional, for GPU acceleration)
|
| 29 |
-
|
| 30 |
-
### Setup
|
| 31 |
-
|
| 32 |
-
1. Clone the repository:
|
| 33 |
-
```bash
|
| 34 |
-
git clone https://huggingface.co/spaces/YOUR_USERNAME/jambogpt
|
| 35 |
-
cd jambogpt
|
| 36 |
-
```
|
| 37 |
-
|
| 38 |
-
2. Create a virtual environment:
|
| 39 |
-
```bash
|
| 40 |
-
python3 -m venv venv
|
| 41 |
-
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 42 |
-
```
|
| 43 |
-
|
| 44 |
-
3. Install dependencies:
|
| 45 |
-
```bash
|
| 46 |
-
pip install -r requirements.txt
|
| 47 |
-
```
|
| 48 |
-
|
| 49 |
-
## Usage
|
| 50 |
-
|
| 51 |
-
### Run Locally
|
| 52 |
-
|
| 53 |
-
```bash
|
| 54 |
-
python app.py
|
| 55 |
-
```
|
| 56 |
-
|
| 57 |
-
The app will be available at `http://localhost:7860`
|
| 58 |
-
|
| 59 |
-
### Deploy to Hugging Face Spaces
|
| 60 |
-
|
| 61 |
-
1. Create a new Space on Hugging Face
|
| 62 |
-
2. Push your code to the Space repository
|
| 63 |
-
3. Gradio will automatically detect `app.py` and deploy it
|
| 64 |
-
|
| 65 |
-
## Architecture
|
| 66 |
-
|
| 67 |
-
**JamboGPT** uses the following technology stack:
|
| 68 |
|
| 69 |
-
|
| 70 |
-
- **Hugging Face Transformers**: Model loading and inference
|
| 71 |
-
- **Meta MMS**: Multilingual speech synthesis models
|
| 72 |
-
- **PyTorch**: Deep learning framework
|
| 73 |
-
- **SciPy**: Audio processing
|
| 74 |
|
| 75 |
-
|
|
|
|
|
|
|
|
|
|
| 76 |
|
| 77 |
-
##
|
| 78 |
|
| 79 |
-
-
|
| 80 |
-
-
|
| 81 |
-
-
|
|
|
|
| 82 |
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
## Performance
|
| 86 |
-
|
| 87 |
-
- **Inference Time**: ~2-5 seconds per 100 words (CPU), <1 second (GPU)
|
| 88 |
-
- **Audio Quality**: 16kHz, 16-bit PCM WAV
|
| 89 |
-
- **Max Text Length**: 1000 characters per request
|
| 90 |
-
|
| 91 |
-
## Roadmap
|
| 92 |
-
|
| 93 |
-
- [ ] Add more African languages (Luo, Luhya, Kamba, Amharic, Yoruba, Igbo, Hausa)
|
| 94 |
-
- [ ] Implement voice cloning
|
| 95 |
-
- [ ] Add speech-to-text (ASR)
|
| 96 |
-
- [ ] Support for multiple speakers
|
| 97 |
-
- [ ] Real-time streaming
|
| 98 |
-
- [ ] Mobile app
|
| 99 |
-
|
| 100 |
-
## Contributing
|
| 101 |
-
|
| 102 |
-
Contributions are welcome! Please feel free to submit pull requests or open issues.
|
| 103 |
-
|
| 104 |
-
## License
|
| 105 |
-
|
| 106 |
-
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 107 |
-
|
| 108 |
-
## Acknowledgments
|
| 109 |
-
|
| 110 |
-
- **Saheed Azeez** for creating Yarn GPT, which inspired this project
|
| 111 |
-
- **Meta AI** for the MMS (Massively Multilingual Speech) models
|
| 112 |
-
- **Hugging Face** for the model hub and Spaces platform
|
| 113 |
-
- **Sunbird AI** for Kikuyu language models
|
| 114 |
-
- **African language communities** for their support and feedback
|
| 115 |
-
|
| 116 |
-
## Citation
|
| 117 |
-
|
| 118 |
-
If you use JamboGPT in your research, please cite:
|
| 119 |
-
|
| 120 |
-
```bibtex
|
| 121 |
-
@software{jambogpt2026,
|
| 122 |
-
title={JamboGPT: African Language AI},
|
| 123 |
-
author={Your Name},
|
| 124 |
-
year={2026},
|
| 125 |
-
url={https://huggingface.co/spaces/YOUR_USERNAME/jambogpt}
|
| 126 |
-
}
|
| 127 |
-
```
|
| 128 |
-
|
| 129 |
-
## Contact
|
| 130 |
-
|
| 131 |
-
- GitHub Issues: [Report a bug](https://github.com/YOUR_USERNAME/jambogpt/issues)
|
| 132 |
-
- Email: your.email@example.com
|
| 133 |
-
- Twitter: [@YourHandle](https://twitter.com/YourHandle)
|
| 134 |
-
|
| 135 |
-
---
|
| 136 |
|
| 137 |
-
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: JamboGPT
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: cyan
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 6.14.0
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
+
---
|
| 12 |
|
| 13 |
+
# JamboGPT - African Language AI
|
| 14 |
|
| 15 |
+
π **JamboGPT** is an open-source AI application for Text-to-Speech (TTS) in Kenyan and African languages.
|
| 16 |
|
| 17 |
## Features
|
| 18 |
|
| 19 |
+
- π€ High-quality Text-to-Speech
|
| 20 |
+
- π Support for Swahili, Kikuyu, and English
|
| 21 |
+
- β‘ Fast inference powered by Meta's MMS models
|
| 22 |
+
- π Open-source and free
|
|
|
|
|
|
|
| 23 |
|
| 24 |
## Supported Languages
|
| 25 |
|
| 26 |
+
- **Swahili** - East African language
|
| 27 |
+
- **Kikuyu** - Bantu language from central Kenya
|
| 28 |
+
- **English** - English language
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 29 |
|
| 30 |
+
## How to Use
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
|
| 32 |
+
1. Enter your text in the text box
|
| 33 |
+
2. Select a language
|
| 34 |
+
3. Click "Generate Speech"
|
| 35 |
+
4. Download the generated audio
|
| 36 |
|
| 37 |
+
## Technology
|
| 38 |
|
| 39 |
+
- Gradio for UI
|
| 40 |
+
- Hugging Face Transformers
|
| 41 |
+
- Meta MMS (Massively Multilingual Speech)
|
| 42 |
+
- PyTorch
|
| 43 |
|
| 44 |
+
## Inspired By
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
+
Yarn GPT by Saheed Azeez - bringing AI to African languages!
|