DeadPool1236 commited on
Commit
3800bca
Β·
verified Β·
1 Parent(s): b43014e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -29
README.md CHANGED
@@ -1,3 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
1
  # πŸ₯ Well Being Agent - Breast Cancer Support
2
 
3
  An AI-powered multilingual breast cancer support system providing evidence-based information and emotional support in English and Urdu.
@@ -13,7 +24,7 @@ An AI-powered multilingual breast cancer support system providing evidence-based
13
 
14
  ## πŸš€ Quick Start
15
 
16
- 1. **Visit** the Well Being Agent Space
17
  2. **Choose your language** - English or Urdu tabs available
18
  3. **Ask questions** via text or voice recording
19
  4. **Get compassionate, accurate responses** about breast cancer
@@ -82,7 +93,6 @@ Frontend β†’ FastAPI Backend β†’ RAG System β†’ OpenRouter LLM
82
  ↓ ↓ ↓ ↓
83
 
84
  User Interface STT Processing Vector Search AI Model
85
-
86
  Voice Recording Caching System Emotional Analysis
87
 
88
  text
@@ -92,32 +102,7 @@ text
92
  - **Text Input**: Directly processed, text response returned
93
  - **No Audio Output**: All responses are text-only for clarity
94
 
95
- ## πŸ› οΈ For Developers
96
-
97
- ### Local Development:
98
- ```bash
99
- pip install -r requirements.txt
100
- uvicorn app:app --host 0.0.0.0 --port 8000
101
- API Endpoints:
102
- POST /ask-query - Process text queries
103
-
104
- POST /voice-query - Process voice queries
105
-
106
- GET /predefined-questions - Get common questions
107
-
108
- GET /health - System health check
109
-
110
- πŸ“ž Support
111
- For Technical Issues:
112
- Check the Hugging Face Space discussions
113
-
114
- Review the application logs
115
-
116
- For Medical Questions:
117
- Consult your healthcare provider
118
-
119
- Contact breast cancer support organizations
120
-
121
 
122
- Built with ❀️ for breast cancer patients and their families
123
 
 
 
1
+ ---
2
+ title: Well Being Agent - Breast Cancer Support
3
+ emoji: πŸ₯
4
+ colorFrom: pink
5
+ colorTo: purple
6
+ sdk: docker
7
+ sdk_version: "3.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
  # πŸ₯ Well Being Agent - Breast Cancer Support
13
 
14
  An AI-powered multilingual breast cancer support system providing evidence-based information and emotional support in English and Urdu.
 
24
 
25
  ## πŸš€ Quick Start
26
 
27
+ 1. **Visit** this Space
28
  2. **Choose your language** - English or Urdu tabs available
29
  3. **Ask questions** via text or voice recording
30
  4. **Get compassionate, accurate responses** about breast cancer
 
93
  ↓ ↓ ↓ ↓
94
 
95
  User Interface STT Processing Vector Search AI Model
 
96
  Voice Recording Caching System Emotional Analysis
97
 
98
  text
 
102
  - **Text Input**: Directly processed, text response returned
103
  - **No Audio Output**: All responses are text-only for clarity
104
 
105
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
106
 
 
107
 
108
+ **Built with ❀️ for breast cancer patients and their families**