matesoft commited on
Commit
38eae38
Β·
verified Β·
1 Parent(s): 19677e1

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +103 -9
README.md CHANGED
@@ -1,13 +1,107 @@
1
  ---
2
- title: Disease Symptom Prediction
3
- emoji: πŸ“Š
4
- colorFrom: indigo
5
- colorTo: green
6
- sdk: gradio
7
- sdk_version: 5.36.2
8
- app_file: app.py
9
- pinned: false
10
  license: mit
11
  ---
 
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
 
 
 
 
 
 
 
 
2
  license: mit
3
  ---
4
+ # 🧠 Disease Symptom Prediction AI
5
 
6
+ ![Python](https://img.shields.io/badge/python-3.10+-blue.svg)
7
+ ![License](https://img.shields.io/github/license/matesoft2033/disease-symptom-predictor-ai)
8
+ ![Issues](https://img.shields.io/github/issues/matesoft2033/disease-symptom-predictor-ai)
9
+
10
+ AI-powered tool that predicts possible diseases based on symptoms using a trained machine learning model and provides chatbot-style suggestions.
11
+
12
+ ---
13
+
14
+ ## πŸ“ Project Structure
15
+
16
+ ```
17
+ disease-symptom-prediction/
18
+ β”œβ”€β”€ data/ # Excel dataset (not uploaded)
19
+ β”‚ └── README.md # Instructions for downloading from Kaggle
20
+ β”‚
21
+ β”œβ”€β”€ src/ # Source code
22
+ β”‚ β”œβ”€β”€ data_preprocessing.py # Cleans & prepares dataset
23
+ β”‚ β”œβ”€β”€ model.py # Trains and saves the ML model
24
+ β”‚ β”œβ”€β”€ predict.py # Predicts disease from symptoms
25
+ β”‚ └── chatbot.py # Symptom-checker chatbot logic
26
+ β”‚
27
+ β”œβ”€β”€ app/ # App interface
28
+ β”‚ └── gradio_app.py # Gradio-based web UI
29
+ β”‚
30
+ β”œβ”€β”€ models/ # Trained model files
31
+ β”‚ └── rf_model.pkl
32
+ β”‚
33
+ β”œβ”€β”€ notebooks/ # Jupyter notebooks for analysis
34
+ β”‚ β”œβ”€β”€ 1_data_exploration.ipynb
35
+ β”‚ β”œβ”€β”€ 2_preprocessing_test.ipynb
36
+ β”‚ └── 3_model_testing.ipynb
37
+ β”‚
38
+ β”œβ”€β”€ requirements.txt # Python dependencies
39
+ β”œβ”€β”€ .gitignore
40
+ └── README.md
41
+ ```
42
+
43
+ ---
44
+
45
+ ## βš™οΈ Installation
46
+
47
+ ### 1. Clone the repository
48
+
49
+ ```bash
50
+ git clone https://github.com/your-username/disease-symptom-prediction.git
51
+ cd disease-symptom-prediction
52
+ ```
53
+
54
+ ### 2. Create virtual environment (optional but recommended)
55
+
56
+ ```bash
57
+ python -m venv venv
58
+ source venv/bin/activate # On Windows: venv\Scripts\activate
59
+ ```
60
+
61
+ ### 3. Install dependencies
62
+
63
+ ```bash
64
+ pip install -r requirements.txt
65
+ ```
66
+
67
+ ---
68
+
69
+ ## πŸš€ Run the App
70
+
71
+ ```bash
72
+ python app/gradio_app.py
73
+ ```
74
+
75
+ The app will start locally and you can open it in your browser at `http://localhost:7860`.
76
+
77
+ ---
78
+
79
+ ## πŸ€– Features
80
+
81
+ - βœ… Predict disease from symptoms
82
+ - 🧠 Trained on structured healthcare dataset
83
+ - πŸ’¬ Chatbot-style health advice
84
+ - πŸ–₯️ User-friendly Gradio interface
85
+
86
+ ---
87
+
88
+ <details>
89
+ <summary>πŸ“¦ Dataset Note (Click to expand)</summary>
90
+
91
+ We use a healthcare dataset available on [Kaggle](https://www.kaggle.com/). Due to licensing, it is not uploaded in this repo. Please download it manually and place it in the `data/` directory.
92
+
93
+ </details>
94
+
95
+ ---
96
+
97
+ ## πŸͺͺ License
98
+
99
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
100
+
101
+ ---
102
+
103
+ ## πŸ™ Credits
104
+
105
+ Created by [Mate](https://github.com/your-username) β€” feel free to fork, star, or contribute.
106
+
107
+ ---