Spaces:
Sleeping
Sleeping
Revise README for clarity and consistency, updating interface descriptions and enhancing user guidance
Browse files
README.md
CHANGED
|
@@ -11,7 +11,9 @@ pinned: false
|
|
| 11 |
|
| 12 |
# Medical Brain - Simplified Medical Assistant with Spiritual Monitoring
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
|
| 15 |
|
| 16 |
## ⚡ Швидкий Старт
|
| 17 |
|
|
@@ -33,14 +35,17 @@ PYTHONPATH=. ./venv/bin/python run_simplified_app.py
|
|
| 33 |
# http://localhost:7860
|
| 34 |
```
|
| 35 |
|
| 36 |
-
**Що включає
|
| 37 |
-
- 💬 **Chat**
|
| 38 |
-
-
|
| 39 |
-
-
|
| 40 |
-
-
|
| 41 |
-
-
|
|
|
|
| 42 |
|
| 43 |
-
|
|
|
|
|
|
|
| 44 |
|
| 45 |
---
|
| 46 |
|
|
@@ -63,19 +68,19 @@ PYTHONPATH=. ./venv/bin/python run_simplified_app.py
|
|
| 63 |
|
| 64 |
### Три Стани Духовного Здоров'я
|
| 65 |
|
| 66 |
-
**🟢 GREEN
|
| 67 |
- Медичні симптоми тільки
|
| 68 |
- Рутинні питання
|
| 69 |
- Стандартні теми здоров'я
|
| 70 |
|
| 71 |
-
**🟡 YELLOW
|
| 72 |
- Стрес, тривога, проблеми зі сном
|
| 73 |
- Горе та втрата
|
| 74 |
- Екзистенціальні питання
|
| 75 |
- Духовна відчуженість
|
| 76 |
- Почуття самотності
|
| 77 |
|
| 78 |
-
**🔴 RED
|
| 79 |
- Суїцидальні думки
|
| 80 |
- Важка безнадійність
|
| 81 |
- Духовна криза
|
|
@@ -102,7 +107,7 @@ PYTHONPATH=. ./venv/bin/python run_simplified_app.py
|
|
| 102 |
**Файл:** `src/core/soft_triage_manager.py`
|
| 103 |
|
| 104 |
### 4. 🎨 Gradio Interface
|
| 105 |
-
|
| 106 |
|
| 107 |
**Файл:** `src/interface/simplified_gradio_app.py`
|
| 108 |
|
|
@@ -137,18 +142,17 @@ http://localhost:7860
|
|
| 137 |
|
| 138 |
## 📚 Документація
|
| 139 |
|
| 140 |
-
###
|
| 141 |
-
-
|
| 142 |
-
-
|
| 143 |
-
-
|
| 144 |
-
- 🤖 [MODEL_SELECTION_GUIDE.md](MODEL_SELECTION_GUIDE.md) - Вибір моделей
|
| 145 |
-
- 📊 [TRIAGE_ANALYSIS.md](TRIAGE_ANALYSIS.md) - Аналіз тріажу
|
| 146 |
|
| 147 |
### Інтерфейс
|
| 148 |
- **Help Tab** - Вбудована документація в додатку
|
| 149 |
- **Model Settings** - Налаштування AI моделей
|
| 150 |
-
- **Patient Profiles** - 15 профілів для тестування
|
| 151 |
- **Edit Prompts** - Редагування системних промптів
|
|
|
|
|
|
|
| 152 |
|
| 153 |
## 🧪 Тестування
|
| 154 |
|
|
@@ -157,7 +161,7 @@ http://localhost:7860
|
|
| 157 |
PYTHONPATH=. ./venv/bin/python -m pytest tests/ -v
|
| 158 |
```
|
| 159 |
|
| 160 |
-
|
| 161 |
|
| 162 |
### Тестування Spiritual Функціоналу
|
| 163 |
```bash
|
|
@@ -172,11 +176,8 @@ PYTHONPATH=. ./venv/bin/python -m pytest tests/test_referral_language_properties
|
|
| 172 |
```
|
| 173 |
|
| 174 |
### Тестування з Профілями
|
| 175 |
-
|
| 176 |
-
|
| 177 |
-
3. Виберіть один з 8 Spiritual Testing Profiles
|
| 178 |
-
4. Завантажте профіль
|
| 179 |
-
5. Перейдіть на "💬 Chat" та тестуйте
|
| 180 |
|
| 181 |
## 📁 Структура Проекту
|
| 182 |
|
|
@@ -189,6 +190,7 @@ PYTHONPATH=. ./venv/bin/python -m pytest tests/test_referral_language_properties
|
|
| 189 |
│ │ ├── soft_triage_manager.py # М'яке питання для тріажу
|
| 190 |
│ │ ├── spiritual_state.py # State machine
|
| 191 |
│ │ └── ai_client.py # AI клієнт
|
|
|
|
| 192 |
│ ├── config/
|
| 193 |
│ │ ├── prompts.py # Системні промпти
|
| 194 |
│ │ └── ai_providers_config.py # Конфігурація моделей
|
|
@@ -222,20 +224,18 @@ PYTHONPATH=. ./venv/bin/python -m pytest tests/test_referral_language_properties
|
|
| 222 |
- 🤖 Вибір між Claude та Gemini
|
| 223 |
- ⚙️ Налаштування для кожного завдання
|
| 224 |
- 🔄 Динамічна зміна моделей
|
| 225 |
-
- 💾 Збереження налаштувань в сесії
|
| 226 |
-
|
| 227 |
-
#### Профілі Пацієнтів
|
| 228 |
-
- �️ 15 предефінованих профілів
|
| 229 |
-
- 🟢 GREEN - Здоровий пацієнт
|
| 230 |
-
- 🟡 YELLOW - 4 типи легкого дистресу
|
| 231 |
-
- � RED - 3 тnипи важкого дистресу
|
| 232 |
-
- 📝 Редагування та збереження налаштувань
|
| 233 |
|
| 234 |
#### Редагування Промптів
|
| 235 |
- 🔧 Редагування 5 системних промптів
|
| 236 |
- � HTML зформатування для читаності
|
| 237 |
- � Скидтання до стандартних
|
| 238 |
-
- �
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 239 |
|
| 240 |
### 🧪 Тестування
|
| 241 |
|
|
@@ -247,7 +247,7 @@ PYTHONPATH=. ./venv/bin/python -m pytest tests/test_referral_language_properties
|
|
| 247 |
|
| 248 |
## 🛠️ Технології
|
| 249 |
|
| 250 |
-
- **Backend:** Python 3
|
| 251 |
- **LLM:** Google Gemini + Anthropic Claude
|
| 252 |
- **UI:** Gradio 6.0.2
|
| 253 |
- **Testing:** Pytest + Hypothesis
|
|
|
|
| 11 |
|
| 12 |
# Medical Brain - Simplified Medical Assistant with Spiritual Monitoring
|
| 13 |
|
| 14 |
+
Simplified medical chat experience with **automatic background monitoring for spiritual distress**.
|
| 15 |
+
|
| 16 |
+
This repository also includes **verification workflows** for chaplains/testers to review classifications and export results for analysis.
|
| 17 |
|
| 18 |
## ⚡ Швидкий Старт
|
| 19 |
|
|
|
|
| 35 |
# http://localhost:7860
|
| 36 |
```
|
| 37 |
|
| 38 |
+
**Що включає інтерфейс (основні вкладки):**
|
| 39 |
+
- 💬 **Chat** — your main medical conversation (spiritual monitoring runs automatically in the background)
|
| 40 |
+
- 🧾 **Conversation Verification** — generate a verification session from chat, review exchanges, and export results
|
| 41 |
+
- 🔍 **Enhanced Verification** — Manual Input + File Upload workflows for structured testing and exports
|
| 42 |
+
- ⚙️ **Model Settings** — choose which model is used per task (applies to the current browser session)
|
| 43 |
+
- 🔧 **Edit Prompts** — session-scoped prompt overrides for testing (does not change defaults globally)
|
| 44 |
+
- 📖 **Help** — end-user guide embedded in the app
|
| 45 |
|
| 46 |
+
For the customer specification, see:
|
| 47 |
+
- `docs/Spiritual Distress Testing Tool.md`
|
| 48 |
+
- `docs/Spiritual Distress Definition, Defining Characteristics, and Descriptions.md`
|
| 49 |
|
| 50 |
---
|
| 51 |
|
|
|
|
| 68 |
|
| 69 |
### Три Стани Духовного Здоров'я
|
| 70 |
|
| 71 |
+
**🟢 GREEN (Not Relevant) — No spiritual distress detected**
|
| 72 |
- Медичні симптоми тільки
|
| 73 |
- Рутинні питання
|
| 74 |
- Стандартні теми здоров'я
|
| 75 |
|
| 76 |
+
**🟡 YELLOW — Potential spiritual distress**
|
| 77 |
- Стрес, тривога, проблеми зі сном
|
| 78 |
- Горе та втрата
|
| 79 |
- Екзистенціальні питання
|
| 80 |
- Духовна відчуженість
|
| 81 |
- Почуття самотності
|
| 82 |
|
| 83 |
+
**🔴 RED — Severe spiritual distress (needs immediate attention)**
|
| 84 |
- Суїцидальні думки
|
| 85 |
- Важка безнадійність
|
| 86 |
- Духовна криза
|
|
|
|
| 107 |
**Файл:** `src/core/soft_triage_manager.py`
|
| 108 |
|
| 109 |
### 4. 🎨 Gradio Interface
|
| 110 |
+
Web interface (Gradio) with Chat + Verification tabs.
|
| 111 |
|
| 112 |
**Файл:** `src/interface/simplified_gradio_app.py`
|
| 113 |
|
|
|
|
| 142 |
|
| 143 |
## 📚 Документація
|
| 144 |
|
| 145 |
+
### Основні документи
|
| 146 |
+
- `docs/Spiritual Distress Testing Tool.md` — customer-facing specification
|
| 147 |
+
- `docs/Spiritual Distress Definition, Defining Characteristics, and Descriptions.md` — distress indicators reference
|
| 148 |
+
- `docs/TROUBLESHOOTING_GUIDE.md` — common issues
|
|
|
|
|
|
|
| 149 |
|
| 150 |
### Інтерфейс
|
| 151 |
- **Help Tab** - Вбудована документація в додатку
|
| 152 |
- **Model Settings** - Налаштування AI моделей
|
|
|
|
| 153 |
- **Edit Prompts** - Редагування системних промптів
|
| 154 |
+
- **Conversation Verification** - Перевірка та експорт з поточного чату
|
| 155 |
+
- **Enhanced Verification** - Manual Input / File Upload + CSV/JSON exports
|
| 156 |
|
| 157 |
## 🧪 Тестування
|
| 158 |
|
|
|
|
| 161 |
PYTHONPATH=. ./venv/bin/python -m pytest tests/ -v
|
| 162 |
```
|
| 163 |
|
| 164 |
+
**Status:** ✅ test suite is green (most recent run: `pytest -q` → 380 passed)
|
| 165 |
|
| 166 |
### Тестування Spiritual Функціоналу
|
| 167 |
```bash
|
|
|
|
| 176 |
```
|
| 177 |
|
| 178 |
### Тестування з Профілями
|
| 179 |
+
This interface no longer relies on "Patient Profiles" as a primary workflow.
|
| 180 |
+
Use **Chat** for free-form testing, or **Enhanced Verification** for structured Manual Input / File Upload workflows.
|
|
|
|
|
|
|
|
|
|
| 181 |
|
| 182 |
## 📁 Структура Проекту
|
| 183 |
|
|
|
|
| 190 |
│ │ ├── soft_triage_manager.py # М'яке питання для тріажу
|
| 191 |
│ │ ├── spiritual_state.py # State machine
|
| 192 |
│ │ └── ai_client.py # AI клієнт
|
| 193 |
+
│ │ └── content_generator.py # Explanations / follow-ups / referrals
|
| 194 |
│ ├── config/
|
| 195 |
│ │ ├── prompts.py # Системні промпти
|
| 196 |
│ │ └── ai_providers_config.py # Конфігурація моделей
|
|
|
|
| 224 |
- 🤖 Вибір між Claude та Gemini
|
| 225 |
- ⚙️ Налаштування для кожного завдання
|
| 226 |
- 🔄 Динамічна зміна моделей
|
| 227 |
+
- 💾 Збереження налаштувань в межах поточної сесії браузера
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 228 |
|
| 229 |
#### Редагування Промптів
|
| 230 |
- 🔧 Редагування 5 системних промптів
|
| 231 |
- � HTML зформатування для читаності
|
| 232 |
- � Скидтання до стандартних
|
| 233 |
+
- � Збереження в сесії (не змінює дефолти глобально)
|
| 234 |
+
|
| 235 |
+
#### Verification & Exports
|
| 236 |
+
- 🧾 Conversation Verification: review chat-derived exchanges and export CSV/JSON
|
| 237 |
+
- 🔍 Enhanced Verification: Manual Input and File Upload for batch testing
|
| 238 |
+
- 📤 Exports: CSV + JSON (CSV “Notes” contains reasoning only)
|
| 239 |
|
| 240 |
### 🧪 Тестування
|
| 241 |
|
|
|
|
| 247 |
|
| 248 |
## 🛠️ Технології
|
| 249 |
|
| 250 |
+
- **Backend:** Python 3
|
| 251 |
- **LLM:** Google Gemini + Anthropic Claude
|
| 252 |
- **UI:** Gradio 6.0.2
|
| 253 |
- **Testing:** Pytest + Hypothesis
|