IntentSnap-AI / README.md
ajm19826's picture
Maintained by HouseLearning
da7eab9 verified
# ๐Ÿค— 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)