Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,13 +1,131 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
-
|
| 11 |
---
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: BarkScan - Pet Food Safety Analyzer
|
| 3 |
+
emoji: πΎ
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: green
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: 4.44.0
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# πΎ BarkScan - Pet Food Safety Analyzer
|
| 14 |
+
|
| 15 |
+
**Scan pet food barcodes to check ingredient safety instantly!**
|
| 16 |
+
|
| 17 |
+
BarkScan is an AI-powered pet food ingredient analyzer that helps pet owners make informed decisions about their pets' nutrition and safety.
|
| 18 |
+
|
| 19 |
+
## Features
|
| 20 |
+
|
| 21 |
+
- π± **Mobile-Friendly**: Works on any device with camera support
|
| 22 |
+
- π **Barcode Scanner**: Automatic barcode detection from images
|
| 23 |
+
- β οΈ **Harmful Substance Detection**: Identifies 10+ dangerous ingredients
|
| 24 |
+
- π― **Safety Grading**: A+ to F rating system (0-100 score)
|
| 25 |
+
- π **Multilingual**: Supports English and Korean products
|
| 26 |
+
- π **Nutritional Analysis**: Protein, fat, fiber breakdown
|
| 27 |
+
|
| 28 |
+
## How to Use
|
| 29 |
+
|
| 30 |
+
1. **Upload a photo** of the pet food barcode or **use your camera** (mobile devices automatically use rear camera)
|
| 31 |
+
2. Click **"Scan & Analyze"**
|
| 32 |
+
3. View the **safety grade**, **harmful substances**, and **nutritional information**
|
| 33 |
+
|
| 34 |
+
## Sample Test Barcodes
|
| 35 |
+
|
| 36 |
+
Try these barcodes to see how BarkScan works:
|
| 37 |
+
|
| 38 |
+
- **8801234567890** - Royal Canin Mini Adult (Grade A - High quality)
|
| 39 |
+
- **8801234567898** - Budget Dog Food (Grade D - β οΈ Contains BHA & Ethoxyquin)
|
| 40 |
+
- **8801234567899** - Orijen Original Dog (Grade A+ - Premium quality)
|
| 41 |
+
|
| 42 |
+
## Detected Harmful Substances
|
| 43 |
+
|
| 44 |
+
BarkScan identifies:
|
| 45 |
+
|
| 46 |
+
- **BHA/BHT** (Preservatives - Potential carcinogens)
|
| 47 |
+
- **Ethoxyquin** (Pesticide - Banned in human food)
|
| 48 |
+
- **Propylene Glycol** (May cause anemia in cats)
|
| 49 |
+
- **Artificial Colors** (Allergic reaction risk)
|
| 50 |
+
- **Meat By-Products** (Low-quality protein)
|
| 51 |
+
- **Carrageenan** (Digestive inflammation)
|
| 52 |
+
- And more...
|
| 53 |
+
|
| 54 |
+
## Safety Grading System
|
| 55 |
+
|
| 56 |
+
| Grade | Score | Description |
|
| 57 |
+
|-------|-------|-------------|
|
| 58 |
+
| A+ | 90-100 | Excellent - Premium quality ingredients |
|
| 59 |
+
| A | 80-89 | Very Good - High quality with minor concerns |
|
| 60 |
+
| B | 70-79 | Good - Acceptable quality |
|
| 61 |
+
| C | 60-69 | Fair - Some concerns |
|
| 62 |
+
| D | 50-59 | Poor - Multiple harmful substances |
|
| 63 |
+
| F | 0-49 | Very Poor - Avoid |
|
| 64 |
+
|
| 65 |
+
## Technology Stack
|
| 66 |
+
|
| 67 |
+
- **Frontend**: Gradio 4.44.0 (2025 latest)
|
| 68 |
+
- **Computer Vision**: OpenCV + ZBar/Pyzbar
|
| 69 |
+
- **Barcode Detection**: Pyzbar
|
| 70 |
+
- **Data Source**: Open Pet Food Facts, Korea Food Safety Database
|
| 71 |
+
|
| 72 |
+
## Data Sources
|
| 73 |
+
|
| 74 |
+
- [Open Pet Food Facts](https://world.openpetfoodfacts.org/) - 13,000+ international products
|
| 75 |
+
- Korea Food Safety Database (μνμμ λλΌ) - Korean market products
|
| 76 |
+
- Veterinary research on harmful pet food ingredients
|
| 77 |
+
|
| 78 |
+
## Local Development
|
| 79 |
+
|
| 80 |
+
```bash
|
| 81 |
+
# Clone the repository
|
| 82 |
+
git clone https://huggingface.co/spaces/YOUR_USERNAME/barkscan
|
| 83 |
+
cd barkscan
|
| 84 |
+
|
| 85 |
+
# Install dependencies
|
| 86 |
+
pip install -r requirements.txt
|
| 87 |
+
|
| 88 |
+
# Run the app
|
| 89 |
+
python app.py
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
## Project Structure
|
| 93 |
+
|
| 94 |
+
```
|
| 95 |
+
huggingface/
|
| 96 |
+
βββ app.py # Main Gradio application
|
| 97 |
+
βββ requirements.txt # Python dependencies
|
| 98 |
+
βββ README.md # This file
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
## Roadmap
|
| 102 |
+
|
| 103 |
+
- [ ] Real-time API integration with backend database
|
| 104 |
+
- [ ] OCR for ingredient list scanning
|
| 105 |
+
- [ ] AI-powered personalized recommendations
|
| 106 |
+
- [ ] Price comparison with online stores
|
| 107 |
+
- [ ] Community reviews and ratings
|
| 108 |
+
- [ ] Vet consultation integration
|
| 109 |
+
|
| 110 |
+
## Contributing
|
| 111 |
+
|
| 112 |
+
Contributions are welcome! Please feel free to submit issues or pull requests.
|
| 113 |
+
|
| 114 |
+
## License
|
| 115 |
+
|
| 116 |
+
MIT License - see LICENSE file for details
|
| 117 |
+
|
| 118 |
+
## Disclaimer
|
| 119 |
+
|
| 120 |
+
BarkScan is designed to help pet owners make informed decisions, but it should not replace professional veterinary advice. Always consult with your veterinarian about your pet's diet and health.
|
| 121 |
+
|
| 122 |
+
## Contact
|
| 123 |
+
|
| 124 |
+
- **Project**: [BarkScan GitHub](https://github.com/YOUR_USERNAME/BarkScan)
|
| 125 |
+
- **Dataset**: [Open Pet Food Facts](https://world.openpetfoodfacts.org/)
|
| 126 |
+
|
| 127 |
+
---
|
| 128 |
+
|
| 129 |
+
**Made with β€οΈ for pet safety**
|
| 130 |
+
|
| 131 |
+
*Version 1.0 (2025)*
|