Blaiseboy commited on
Commit
d30e914
Β·
verified Β·
1 Parent(s): 6a9bb1c

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +163 -0
README.md ADDED
@@ -0,0 +1,163 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: BioGPT Medical Assistant
3
+ emoji: πŸ₯
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: 4.44.0
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ short_description: AI pediatric medical chatbot powered by BioGPT
12
+ tags:
13
+ - medical
14
+ - healthcare
15
+ - pediatric
16
+ - biogpt
17
+ - chatbot
18
+ - medicine
19
+ - health
20
+ models:
21
+ - microsoft/BioGPT-Large
22
+ datasets: []
23
+ ---
24
+
25
+
26
+ # πŸ₯ BioGPT Medical Assistant
27
+
28
+ An AI-powered medical chatbot specialized in pediatric medicine, built with Microsoft's BioGPT model and deployed via Gradio.
29
+
30
+ ## 🎯 Features
31
+
32
+ - **Specialized Medical AI**: Powered by BioGPT-Large, trained on extensive medical literature
33
+ - **Pediatric Focus**: Specialized knowledge in children's health and medicine
34
+ - **Evidence-Based**: Responses based on medical research and clinical guidelines
35
+ - **Interactive Chat**: User-friendly Gradio interface with medical-themed design
36
+ - **Safety First**: Clear disclaimers and guidance on when to seek professional care
37
+
38
+ ## 🩺 Capabilities
39
+
40
+ ### Medical Topics Covered:
41
+ - **Pediatric Symptoms**: Fever, cough, rash, digestive issues
42
+ - **Treatment Guidance**: Evidence-based treatment information
43
+ - **Emergency Signs**: When to seek immediate medical attention
44
+ - **Prevention**: Vaccination schedules, disease prevention
45
+ - **Development**: Growth and developmental milestones
46
+
47
+ ### Key Features:
48
+ - Real-time medical information retrieval
49
+ - Context-aware responses using medical knowledge base
50
+ - Conversational AI with natural language understanding
51
+ - Memory-efficient deployment with model quantization
52
+ - Comprehensive medical disclaimers and safety information
53
+
54
+ ## πŸš€ Technical Details
55
+
56
+ - **Base Model**: Microsoft BioGPT-Large
57
+ - **Framework**: Gradio for web interface
58
+ - **Deployment**: Hugging Face Spaces
59
+ - **Optimization**: 8-bit quantization for efficient GPU usage
60
+ - **Embeddings**: Sentence transformers for context retrieval
61
+ - **Device Support**: CUDA GPU with CPU fallback
62
+
63
+ ## ⚠️ Important Medical Disclaimer
64
+
65
+ **This AI assistant provides educational medical information only and is NOT a substitute for professional medical advice, diagnosis, or treatment.**
66
+
67
+ ### Always Consult Healthcare Professionals For:
68
+ - Medical diagnosis and treatment decisions
69
+ - Prescription medications
70
+ - Personalized medical advice
71
+ - Emergency medical situations
72
+
73
+ ### Emergency Situations - Call Emergency Services:
74
+ - Difficulty breathing or choking
75
+ - Severe allergic reactions
76
+ - Unconsciousness
77
+ - Severe injuries
78
+ - Persistent high fever (>104Β°F/40Β°C)
79
+
80
+ ## πŸ› οΈ Installation & Setup
81
+
82
+ ### For Local Development:
83
+
84
+ 1. **Clone the repository**:
85
+ ```bash
86
+ git clone <your-repo-url>
87
+ cd biogpt-medical-chatbot
88
+ ```
89
+
90
+ 2. **Install dependencies**:
91
+ ```bash
92
+ pip install -r requirements.txt
93
+ ```
94
+
95
+ 3. **Run the application**:
96
+ ```bash
97
+ python app.py
98
+ ```
99
+
100
+ ### For Hugging Face Spaces Deployment:
101
+
102
+ 1. Create a new Space on Hugging Face
103
+ 2. Choose "Gradio" as the Space SDK
104
+ 3. Upload the following files:
105
+ - `app.py`
106
+ - `requirements.txt`
107
+ - `README.md`
108
+ 4. The Space will automatically build and deploy
109
+
110
+ ## πŸ“ File Structure
111
+
112
+ ```
113
+ β”œβ”€β”€ app.py # Main Gradio application
114
+ β”œβ”€β”€ requirements.txt # Python dependencies
115
+ └── README.md # This file
116
+ ```
117
+
118
+ ## πŸ”§ Configuration
119
+
120
+ The chatbot automatically detects available hardware and configures accordingly:
121
+
122
+ - **GPU Available**: Uses CUDA with 8-bit quantization
123
+ - **CPU Only**: Falls back to CPU with appropriate settings
124
+ - **Model Loading**: Attempts BioGPT-Large, falls back to smaller models if needed
125
+
126
+ ## πŸ’‘ Usage Tips
127
+
128
+ ### For Best Results:
129
+ 1. **Be Specific**: Ask detailed questions about symptoms or conditions
130
+ 2. **Include Context**: Mention age, duration of symptoms, etc.
131
+ 3. **Medical Focus**: Focus on pediatric and general medical topics
132
+ 4. **Clear Language**: Use clear, simple language in your questions
133
+
134
+ ### Example Queries:
135
+ - "What causes fever in children?"
136
+ - "My 3-year-old has been coughing for 2 days, what should I do?"
137
+ - "When should I be concerned about my baby's breathing?"
138
+ - "What are the signs of dehydration in infants?"
139
+
140
+ ## 🀝 Contributing
141
+
142
+ Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.
143
+
144
+ ## πŸ“„ License
145
+
146
+ This project is licensed under the MIT License - see the LICENSE file for details.
147
+
148
+ ## πŸ™ Acknowledgments
149
+
150
+ - **Microsoft Research** for the BioGPT model
151
+ - **Hugging Face** for model hosting and transformers library
152
+ - **Gradio** for the web interface framework
153
+ - **Medical Community** for evidence-based medical knowledge
154
+
155
+ ## πŸ“ž Support
156
+
157
+ For technical issues or questions about deployment, please open an issue in this repository.
158
+
159
+ **For medical emergencies, always contact emergency services or healthcare professionals immediately.**
160
+
161
+ ---
162
+
163
+ *Last updated: August 2025*