Maintained by HouseLearning

README.md

@@ -1,3 +1,72 @@
----
-license: mit
----
+# 🤗 IntentSnap-AI
+
+IntentSnap-AI is a Hugging Face–powered **intent classification model** designed to understand what a user wants from natural language input.
+
+It turns plain text into structured intents for use in chatbots, assistants, apps, and automation systems.
+
+#### Author: Alex Manochio
+---
+
+## 🏫 About HouseLearning
+
+This project is created and maintained by **HouseLearning**.
+
+- 🌐 Website: https://www.houselearning.org
+- 🎓 Mission: Building accessible, practical tools for learning computer science, AI, and software development.
+
+IntentSnap-AI is part of HouseLearning’s open-source efforts to make modern AI understandable and usable by students, educators, and developers.
+
+---
+
+## 🧠 What This Model Does
+
+The model classifies text into predefined **intents**, such as:
+
+- `open_settings`
+- `shutdown`
+- `restart`
+- `play_music`
+- `pause_music`
+- `get_time`
+- `open_browser`
+
+Example:
+
+Input: "Open the browser"
+Output: open_browser
+
+
+---
+
+## 📁 Project Structure
+
+```
+intentsnap-ai/
+├── data/
+│ └── intents.csv
+├── model/
+├── train.py
+├── predict.py
+├── requirements.txt
+└── README.md
+```
+
+---
+
+## 🚀 Getting Started
+
+### Install dependencies
+
+```bash
+pip install -r requirements.txt
+Train the model
+python train.py
+The trained model will be saved to the model/ directory.
+
+🔮 Run Inference
+python predict.py
+Type a sentence and the model will predict the intent in real time.
+
+🧪 Example Output
+> Shut down the system
+🎯 Intent: shutdown (0.98)