Spaces:
Build error
Build error
Update README.md
Browse files
README.md
CHANGED
|
@@ -10,4 +10,47 @@ pinned: false
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# AI Speech Therapist
|
| 14 |
+
|
| 15 |
+
A voice-interactive AI speech therapy tool powered by LiveKit and OpenAI, designed for students with speech impediments and neurodivergent traits.
|
| 16 |
+
|
| 17 |
+
## Description
|
| 18 |
+
|
| 19 |
+
This Gradio application creates a low-latency voice-to-voice interaction between students and an AI speech therapist. It's specifically optimized for students with ASD and other neurodivergent conditions, featuring clear communication and a repeat function.
|
| 20 |
+
|
| 21 |
+
## Features
|
| 22 |
+
|
| 23 |
+
- **Voice-to-Voice Interaction**: Real-time conversations using OpenAI's speech models
|
| 24 |
+
- **Low Latency**: Optimized processing for minimal delay
|
| 25 |
+
- **Repeat Function**: Helps students who need information repeated
|
| 26 |
+
- **Structured Therapy**: Following speech pathology best practices
|
| 27 |
+
|
| 28 |
+
## Requirements
|
| 29 |
+
|
| 30 |
+
- Python 3.8+
|
| 31 |
+
- OpenAI API key
|
| 32 |
+
- LiveKit account (room URL and token)
|
| 33 |
+
|
| 34 |
+
## Setup
|
| 35 |
+
|
| 36 |
+
### Environment Variables
|
| 37 |
+
|
| 38 |
+
```
|
| 39 |
+
OPENAI_API_KEY=your_openai_api_key
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
### Installation
|
| 43 |
+
|
| 44 |
+
```bash
|
| 45 |
+
pip install -r requirements.txt
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## Usage
|
| 49 |
+
|
| 50 |
+
1. Enter your LiveKit room URL and token in the provided fields
|
| 51 |
+
2. Click "Start Session" to begin
|
| 52 |
+
3. Speak clearly into your microphone
|
| 53 |
+
4. Click "Repeat Last Response" if needed
|
| 54 |
+
5. End the session when finished
|
| 55 |
+
|
| 56 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|