Spaces:
Sleeping
Sleeping
File size: 2,195 Bytes
186f78e 0e9d5b4 186f78e 0e9d5b4 186f78e e4b0995 6c2c3b4 e4b0995 6c2c3b4 e4b0995 6c2c3b4 e4b0995 6c2c3b4 186f78e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
---
title: OMANI-Chatbot
emoji: 💻
colorFrom: blue
colorTo: blue
sdk: streamlit
sdk_version: 1.50.0
app_file: OMANI-Chatbot.py
pinned: false
license: mit
---
# README.md
# 🇴🇲 OMANI-Chatbot
OMANI-Chatbot is a mental health–focused conversational assistant designed to provide supportive dialogue, intent recognition, and safe responses.
It integrates **speech-to-text (STT)**, **text-to-speech (TTS)**, **retrieval-augmented generation (RAG)**, and **emotion detection** into a single pipeline.
---
## 📂 Project Structure
```
OMANI-Chatbot.py # Main entrypoint
app/ # Core application logic
data/ # Knowledge base + Chroma vector database
documentation/ # Architecture diagrams and reports
tests/ # Unit tests, audio samples, transcripts
requirements.txt # Python dependencies
````
---
## ⚙️ Setup & Installation
### 1. Clone the repository
```bash
git clone https://github.com/russelljeffrey/Omani-therapist-voice.git
````
### 2. Create virtual environment & install dependencies
```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
---
## 🚀 Running the Project
### Option A: Run Locally
```bash
streamlit run OMANI-Chatbot.py
```
By default, the Streamlit UI will launch on **[http://localhost:8501](http://localhost:8501)**
---
### Option B: Run with Docker
1. Build the Docker image:
```bash
docker build -t omani-chatbot .
```
2. Run the container:
```bash
docker run -p 8501:8501 omani-chatbot
```
Open your browser at **[http://localhost:8501](http://localhost:8501)** to use the chatbot.
---
## 📖 Documentation
See the `documentation/` folder for:
* `architecture.md` → System overview
* `safety_protocol.md` → Safety design
* `future_roadmap.md` → Planned improvements
* `wer_report.md` → Performance metrics
---
## 🧪 Testing
Run the tests with:
```bash
python -m pytest -s -v tests/
```
---
## 🛡️ Safety Note
This project is for **demo purposes**.
It is **not a substitute for professional mental health care**. If someone is in crisis, they should seek immediate professional support.
--- |