Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,33 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
# 🧠 Mental Health Text Classifier
|
| 5 |
+
|
| 6 |
+
This repository contains an AI-powered tool designed to classify text into one of the following mental health categories:
|
| 7 |
+
- **Stress**
|
| 8 |
+
- **Anxiety**
|
| 9 |
+
- **Depression**
|
| 10 |
+
- **Other**
|
| 11 |
+
|
| 12 |
+
It leverages **OpenAI's GPT-4** for classification using few-shot learning, combined with BM25 for contextual similarity.
|
| 13 |
+
|
| 14 |
+
## Features
|
| 15 |
+
- **User-Friendly Interface:** Easy-to-use Gradio-powered web application.
|
| 16 |
+
- **Interactive Classification:** Real-time text input and predictions.
|
| 17 |
+
- **Extensibility:** Reusable `MentalHealthClassifier` model for integration into other projects.
|
| 18 |
+
|
| 19 |
+
## How It Works
|
| 20 |
+
1. The user provides a text input (e.g., thoughts or feelings).
|
| 21 |
+
2. The tool uses BM25 to retrieve similar examples from the training data.
|
| 22 |
+
3. GPT-4 analyzes the input and predicts the best-fitting mental health category.
|
| 23 |
+
|
| 24 |
+
## Prerequisites
|
| 25 |
+
- **Python 3.8+**
|
| 26 |
+
- OpenAI API Key (Get one from [OpenAI](https://platform.openai.com/signup/))
|
| 27 |
+
- Hugging Face Token (Optional, for dataset access)
|
| 28 |
+
|
| 29 |
+
## Installation
|
| 30 |
+
1. Clone the repository:
|
| 31 |
+
```bash
|
| 32 |
+
git clone https://github.com/your-username/mental-health-classifier.git
|
| 33 |
+
cd mental-health-classifier
|