Update README.md
Browse files
README.md
CHANGED
|
@@ -10,4 +10,54 @@ pinned: false
|
|
| 10 |
short_description: A dog loving space
|
| 11 |
---
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
short_description: A dog loving space
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# πΆ Dog Breed Classifier (Gradio + Hugging Face)
|
| 14 |
+
|
| 15 |
+
This web app uses a powerful transformer-based model from Hugging Face to classify dog breeds from uploaded images.
|
| 16 |
+
|
| 17 |
+
## π Model
|
| 18 |
+
- **Name:** prithivMLmods/Dog-Breed-120
|
| 19 |
+
- **Base architecture:** SigLIP (Vision Transformer)
|
| 20 |
+
- **Classes:** 120 dog breeds
|
| 21 |
+
|
| 22 |
+
## π Features
|
| 23 |
+
- Built with **Gradio** for easy web interaction
|
| 24 |
+
- Powered by **Transformers + PyTorch**
|
| 25 |
+
- Can run on **Hugging Face Spaces** with no backend setup
|
| 26 |
+
|
| 27 |
+
## π File Structure
|
| 28 |
+
```
|
| 29 |
+
dog-breed-app/
|
| 30 |
+
βββ app.py # Main app file
|
| 31 |
+
βββ requirements.txt # Python dependencies
|
| 32 |
+
βββ README.md # This file
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
## π§ͺ Local Setup
|
| 36 |
+
```bash
|
| 37 |
+
# Create and activate environment (optional)
|
| 38 |
+
conda create -n dog-breed python=3.10 -y
|
| 39 |
+
conda activate dog-breed
|
| 40 |
+
|
| 41 |
+
# Install dependencies
|
| 42 |
+
pip install -r requirements.txt
|
| 43 |
+
|
| 44 |
+
# Run the app
|
| 45 |
+
python app.py
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## π Deploy to Hugging Face Spaces
|
| 49 |
+
1. Go to [https://huggingface.co/spaces](https://huggingface.co/spaces)
|
| 50 |
+
2. Create a new Space (select **Gradio** as SDK)
|
| 51 |
+
3. Upload `app.py` and `requirements.txt`
|
| 52 |
+
4. Your app will be live at: `https://huggingface.co/spaces/your-username/your-app`
|
| 53 |
+
|
| 54 |
+
## β¨ Example Use
|
| 55 |
+
Upload a photo like this:
|
| 56 |
+

|
| 57 |
+
|
| 58 |
+
And get a result like:
|
| 59 |
+
```
|
| 60 |
+
golden_retriever (98.4%)
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
Enjoy building! πΎ
|