DocUA commited on
Commit
96e7507
·
1 Parent(s): 62fd510

docs: Update local launch documentation for multi-mode interface

Browse files

- Updated QUICK_START.md with comprehensive launch instructions
- Added description of 4 assistant modes (Medical, Lifestyle, Spiritual, Combined)
- Documented all interface tabs (Main Chat, Testing Lab, Edit Prompts, Instructions)
- Added both API keys requirement (Gemini + Anthropic)
- Updated troubleshooting section with common errors
- Added information about K/L/S/T automatic classification
- Included Gradio 6.0.2 specific notes

Files changed (2) hide show
  1. QUICK_START.md +93 -8
  2. README.md +20 -0
QUICK_START.md CHANGED
@@ -1,24 +1,80 @@
1
  # ⚡ Швидкий Старт - Medical Brain
2
 
 
 
 
 
 
 
 
 
 
 
3
  ## 🚀 Запуск за 3 Кроки
4
 
5
  ### 1️⃣ Налаштування (Перший раз)
6
 
7
  ```bash
8
- # Створити .env файл з API ключем
9
- echo "GEMINI_API_KEY=your_api_key_here" > .env
 
 
 
10
  ```
11
 
12
- ### 2️⃣ Запуск
 
 
 
 
13
 
14
  ```bash
 
15
  ./start.sh
 
 
 
 
16
  ```
17
 
18
  ### 3️⃣ Використання
19
 
20
  Відкрийте браузер: **http://localhost:7860**
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
  ---
23
 
24
  ## 🎯 Що Далі?
@@ -27,7 +83,8 @@ echo "GEMINI_API_KEY=your_api_key_here" > .env
27
  📖 Читайте: [docs/spiritual/ЗАПУСК_ДОДАТКУ.md](docs/spiritual/ЗАПУСК_ДОДАТКУ.md)
28
 
29
  ### Для Розробників
30
- 💻 Читайте: [docs/spiritual/spiritual_README.md](docs/spiritual/spiritual_README.md)
 
31
 
32
  ### Для Адміністраторів
33
  🔧 Читайте: [docs/spiritual/SPIRITUAL_DEPLOYMENT_CHECKLIST.md](docs/spiritual/SPIRITUAL_DEPLOYMENT_CHECKLIST.md)
@@ -39,10 +96,13 @@ echo "GEMINI_API_KEY=your_api_key_here" > .env
39
  ```bash
40
  # Запустити тести
41
  source venv/bin/activate
42
- pytest tests/spiritual/ -v
 
 
 
43
  ```
44
 
45
- **Очікуваний результат:** ✅ 145/145 тестів пройдено
46
 
47
  ---
48
 
@@ -58,6 +118,17 @@ pytest tests/spiritual/ -v
58
 
59
  ## ❓ Проблеми?
60
 
 
 
 
 
 
 
 
 
 
 
 
61
  ### Помилка: "venv not found"
62
 
63
  ```bash
@@ -72,10 +143,24 @@ pip install -r requirements.txt
72
  lsof -i :7860 | grep LISTEN | awk '{print $2}' | xargs kill -9
73
  ```
74
 
75
- ### Помилка: "API Key not found"
76
 
77
  ```bash
78
- echo "GEMINI_API_KEY=your_api_key_here" > .env
 
 
 
 
 
 
 
 
 
 
 
 
 
 
79
  ```
80
 
81
  ---
 
1
  # ⚡ Швидкий Старт - Medical Brain
2
 
3
+ ## 🎯 Що Включає Додаток
4
+
5
+ **🏥 Lifestyle Journey + 🕊️ Spiritual Health Assessment + 🧪 Testing Lab + 🔧 Prompt Editor**
6
+
7
+ Комплексна система з 4 режимами роботи:
8
+ - **Medical Only** - медичний тріаж та консультації
9
+ - **Lifestyle Focus** - персоналізовані рекомендації щодо способу життя
10
+ - **Spiritual Focus** - оцінка духовного дистресу
11
+ - **Combined** - координована підтримка Lifestyle + Spiritual
12
+
13
  ## 🚀 Запуск за 3 Кроки
14
 
15
  ### 1️⃣ Налаштування (Перший раз)
16
 
17
  ```bash
18
+ # Створити .env файл з API ключами
19
+ cat > .env << EOF
20
+ GEMINI_API_KEY=your_gemini_api_key_here
21
+ ANTHROPIC_API_KEY=your_anthropic_api_key_here
22
+ EOF
23
  ```
24
 
25
+ **Примітка:** Потрібні обидва ключі для повної функціональності:
26
+ - **Gemini API** - для класифікації та швидких операцій
27
+ - **Anthropic API** - для діалогів та аналізу (Claude Sonnet 4.5)
28
+
29
+ ### 2️⃣ Запуск Інтерфейсу
30
 
31
  ```bash
32
+ # Автоматичний запуск (рекомендовано)
33
  ./start.sh
34
+
35
+ # АБО ручний запуск
36
+ source venv/bin/activate
37
+ python src/interface/gradio_app.py
38
  ```
39
 
40
  ### 3️⃣ Використання
41
 
42
  Відкрийте браузер: **http://localhost:7860**
43
 
44
+ **Доступні вкладки:**
45
+ - 💬 **Main Chat** - основний інтерфейс з вибором режиму асистента
46
+ - 🧪 **Testing Lab** - тестування з готовими пацієнтами
47
+ - 🔧 **Edit Prompts** - редагування системних промптів
48
+ - 📖 **Instructions** - інструкції та приклади використання
49
+
50
+ ---
51
+
52
+ ## 🎯 Вибір Режиму Асистента
53
+
54
+ У вкладці **Main Chat** доступні 4 режими:
55
+
56
+ ### 🏥 Medical Only
57
+ - Медичний тріаж та консультації
58
+ - Обробка симптомів та скарг
59
+ - Рекомендації щодо звернення до лікаря
60
+
61
+ ### 💚 Lifestyle Focus
62
+ - Персоналізовані рекомендації щодо способу життя
63
+ - Програми вправ та харчування
64
+ - Відстеження прогресу
65
+
66
+ ### 🕊️ Spiritual Focus
67
+ - Оцінка духовного та емоційного дистресу
68
+ - Автоматичне виявлення red/yellow flags
69
+ - Генерація referrals для chaplain team
70
+
71
+ ### 🌟 Combined (Lifestyle + Spiritual)
72
+ - Координована підтримка обох асистентів
73
+ - Інтелектуальна пріоритизація відповідей
74
+ - Комплексний підхід до здоров'я
75
+
76
+ **Автоматична класифікація:** Система використовує Entry Classifier (K/L/S/T) для визначення найкращого режиму на основі повідомлення пацієнта.
77
+
78
  ---
79
 
80
  ## 🎯 Що Далі?
 
83
  📖 Читайте: [docs/spiritual/ЗАПУСК_ДОДАТКУ.md](docs/spiritual/ЗАПУСК_ДОДАТКУ.md)
84
 
85
  ### Для Розробників
86
+ 💻 Читайте: [docs/spiritual/spiritual_README.md](docs/spiritual/spiritual_README.md)
87
+ 💻 Конфігурація LLM: [LLM_MODELS_CONFIGURATION.md](LLM_MODELS_CONFIGURATION.md)
88
 
89
  ### Для Адміністраторів
90
  🔧 Читайте: [docs/spiritual/SPIRITUAL_DEPLOYMENT_CHECKLIST.md](docs/spiritual/SPIRITUAL_DEPLOYMENT_CHECKLIST.md)
 
96
  ```bash
97
  # Запустити тести
98
  source venv/bin/activate
99
+ pytest tests/ -v
100
+
101
+ # Або тільки ключові тести
102
+ pytest tests/test_combined_assistant.py tests/test_spiritual_assistant.py tests/test_entry_classifier.py -v
103
  ```
104
 
105
+ **Очікуваний результат:** ✅ Всі тести пройдено (32+ тестів для multi-mode integration)
106
 
107
  ---
108
 
 
118
 
119
  ## ❓ Проблеми?
120
 
121
+ ### Помилка: "No AI providers available"
122
+
123
+ ```bash
124
+ # Перевірте наявність обох API ключів
125
+ cat .env
126
+
127
+ # Повинно бути:
128
+ # GEMINI_API_KEY=...
129
+ # ANTHROPIC_API_KEY=...
130
+ ```
131
+
132
  ### Помилка: "venv not found"
133
 
134
  ```bash
 
143
  lsof -i :7860 | grep LISTEN | awk '{print $2}' | xargs kill -9
144
  ```
145
 
146
+ ### Помилка: "Module not found"
147
 
148
  ```bash
149
+ # Переконайтесь, що venv активовано
150
+ source venv/bin/activate
151
+
152
+ # Переінсталюйте залежності
153
+ pip install -r requirements.txt
154
+ ```
155
+
156
+ ### Помилка при запуску Gradio 6.0.2
157
+
158
+ ```bash
159
+ # Перевірте версію Gradio
160
+ pip show gradio
161
+
162
+ # Якщо потрібно, оновіть
163
+ pip install --upgrade gradio==6.0.2
164
  ```
165
 
166
  ---
README.md CHANGED
@@ -15,10 +15,30 @@ pinned: false
15
 
16
  ## ⚡ Швидкий Старт
17
 
 
 
 
 
18
  ```bash
 
 
 
 
 
 
 
19
  ./start.sh
 
 
 
20
  ```
21
 
 
 
 
 
 
 
22
  Детальніше: [QUICK_START.md](QUICK_START.md)
23
 
24
  ---
 
15
 
16
  ## ⚡ Швидкий Старт
17
 
18
+ ### Локальний Запуск
19
+
20
+ **🏥 Lifestyle Journey + 🕊️ Spiritual Health Assessment + 🧪 Testing Lab + 🔧 Prompt Editor**
21
+
22
  ```bash
23
+ # 1. Налаштувати API ключі (перший раз)
24
+ cat > .env << EOF
25
+ GEMINI_API_KEY=your_gemini_api_key_here
26
+ ANTHROPIC_API_KEY=your_anthropic_api_key_here
27
+ EOF
28
+
29
+ # 2. Запустити додаток
30
  ./start.sh
31
+
32
+ # 3. Відкрити в браузері
33
+ # http://localhost:7860
34
  ```
35
 
36
+ **Що включає інтерфейс:**
37
+ - 💬 **Main Chat** - 4 режими асистента (Medical, Lifestyle, Spiritual, Combined)
38
+ - 🧪 **Testing Lab** - тестування з готовими пацієнтами
39
+ - 🔧 **Edit Prompts** - редагування системних промптів (4 типи)
40
+ - 📖 **Instructions** - інструкції та приклади
41
+
42
  Детальніше: [QUICK_START.md](QUICK_START.md)
43
 
44
  ---