Update README.md

README.md

@@ -3,4 +3,29 @@ license: mit
 language:
 - en
 pipeline_tag: zero-shot-classification
----
+---
+
+# Automatic Stack Overflow Question Classifier
+
+## Important
+
+All credit goes to huggingface user [MoritzLaurer](https://huggingface.co/MoritzLaurer) as his model is the basis for this project.
+
+## Introduction
+The Automatic Stack Overflow Question Classifier harnesses the latest advancements in artificial intelligence to systematically categorize questions on Stack Overflow. Its primary goal is to streamline the process of sorting queries, enhancing navigability, and improving the overall user experience on the platform.
+
+## About the Project
+This initiative takes advantage of the DeBERTa V3 model's capabilities in zero-shot classification. By doing so, it aims to revolutionize how questions are organized on Stack Overflow. Instead of relying on manual categorization, which can be time-consuming and inconsistent, this project introduces an automated, AI-driven approach for more precise and efficient question sorting.
+
+## Code and Repository
+Access the complete source code and project details on GitHub: [Stack Overflow Question Classifier Repository](https://github.com/amaye15/stackoverflow-question-classifier).
+
+## Streamlit App
+
+Access our live classifier [here](https://stack-overflow-question-classifier.streamlit.app/). This interactive web application demonstrates the model's capabilities in real-time.
+
+## Model
+Learn more about the DeBERTa V3 model and its adaptation for this project on Hugging Face: [DeBERTa V3 on Hugging Face](https://huggingface.co/amaye15/Stack-Overflow-Zero-Shot-Classification).
+
+## Dataset
+The dataset, curated specifically for this project, can be found here: [Stack Overflow Zero-Shot Classification Dataset](https://huggingface.co/datasets/amaye15/Stack-Overflow-Zero-Shot-Classification). It encompasses a wide range of Stack Overflow questions, providing a comprehensive base for model training and testing.