HMWCS commited on
Commit
61bd66a
Β·
verified Β·
1 Parent(s): be449ca

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -76
README.md CHANGED
@@ -1,76 +1,25 @@
1
- # Waste Classification Application
2
-
3
- This project is a web-based application that classifies waste materials from user-uploaded images. It identifies the type of waste (e.g., cardboard, glass, metal) and provides information on how to properly dispose of it.
4
-
5
- ## πŸš€ Live Demo
6
-
7
- Try the application live on Hugging Face Spaces\!
8
-
9
- **➑️ [Waste Classification Demo](https://huggingface.co/spaces/HMWCS/Gemma3n-challenge-demo)**
10
-
11
- -----
12
-
13
- ## ✨ Features
14
-
15
- * **Image-based classification:** Upload an image of a waste item to have it automatically classified.
16
- * **Multiple waste categories:** The application can identify a variety of waste materials.
17
- * **Disposal information:** After classification, the app provides guidance on how to dispose of the identified waste material.
18
- * **Web interface:** A user-friendly web interface built with Gradio makes the application easy to use.
19
-
20
- -----
21
-
22
- ## πŸ’‘ How it works
23
-
24
- The application uses a pre-trained Gemma3n model to perform the image classification. The model has been fine-tuned on a dataset of waste images to accurately identify different materials. The disposal information is retrieved from a knowledge base within the application.
25
-
26
- -----
27
-
28
- ## πŸ““ Kaggle Notebook
29
-
30
- Explore the model fine-tuning process and the underlying code in our detailed Kaggle Notebook.
31
-
32
- **➑️ [Gemma3n Challenge Notebook](https://www.kaggle.com/code/yichuanhuang/gemma3n-garbage-classification)**
33
-
34
- -----
35
-
36
- ## πŸ› οΈ Getting Started
37
-
38
- ### Prerequisites
39
-
40
- * Python 3.9+
41
- * Pip
42
- * Cuda (optional)
43
-
44
- ### Installation
45
-
46
- 1. Clone the repository:
47
- ```bash
48
- git clone https://github.com/yichuan-huang/gemma3n-challenge
49
- ```
50
- 2. Navigate to the project directory:
51
- ```bash
52
- cd gemma3n-challenge
53
- ```
54
- 3. Install the required dependencies:
55
- ```bash
56
- pip install -r requirements.txt
57
- ```
58
-
59
- ### Running the application
60
-
61
- To start the application, run the following command:
62
-
63
- ```bash
64
- python app.py
65
- ```
66
-
67
- This will launch a Gradio web server. You can access the application by opening the provided URL in your web browser.
68
-
69
- ## πŸ“‚ Project Structure
70
-
71
- * `app.py`: The main application file, containing the Gradio interface and the classification logic.
72
- * `classifier.py`: Handles the image classification using the pre-trained model.
73
- * `config.py`: Contains configuration settings for the application, such as the model name and labels.
74
- * `knowledge_base.py`: A simple knowledge base containing disposal information for different waste materials.
75
- * `requirements.txt`: A list of the Python dependencies required to run the application.
76
- * `test_images/`: A directory containing sample images for testing the application.
 
1
+ ---
2
+ title: Gemma3n Challenge
3
+ emoji: 🌍
4
+ colorFrom: green
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 5.37.0
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # Garbage Classification System
14
+
15
+ A Gradio app for classifying garbage into 4 categories using Gemma-3n model.
16
+
17
+ ## Usage
18
+ 1. Upload an image.
19
+ 2. Click "Classify Garbage" or wait for auto-classification.
20
+
21
+ ## Categories
22
+ - Recyclable Waste
23
+ - Food/Kitchen Waste
24
+ - Hazardous Waste
25
+ - Other Waste