yichuan-huang commited on
Commit
754ab42
·
1 Parent(s): c3d6a8d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -24
README.md CHANGED
@@ -2,29 +2,42 @@
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
- ## Features
6
 
7
- * **Image-based classification:** Upload an image of a waste item to have it automatically classified.
8
- * **Multiple waste categories:** The application can identify a variety of waste materials.
9
- * **Disposal information:** After classification, the app provides guidance on how to dispose of the identified waste material.
10
- * **Web interface:** A user-friendly web interface built with Gradio makes the application easy to use.
11
 
12
- ## How it works
13
 
14
- The application uses a pre-trained Vision Transformer (ViT) 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.
15
 
16
- ## Getting Started
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
 
18
  ### Prerequisites
19
 
20
- * Python 3.7+
21
- * Pip
 
22
 
23
  ### Installation
24
 
25
  1. Clone the repository:
26
  ```bash
27
- git clone https://github.com/yichuan-huang/gemma3n-challenge
28
  ```
29
  2. Navigate to the project directory:
30
  ```bash
@@ -40,16 +53,4 @@ The application uses a pre-trained Vision Transformer (ViT) model to perform the
40
  To start the application, run the following command:
41
 
42
  ```bash
43
- python app.py
44
- ```
45
-
46
- This will launch a Gradio web server. You can access the application by opening the provided URL in your web browser.
47
-
48
- ## Project Structure
49
-
50
- * `app.py`: The main application file, containing the Gradio interface and the classification logic.
51
- * `classifier.py`: Handles the image classification using the pre-trained model.
52
- * `config.py`: Contains configuration settings for the application, such as the model name and labels.
53
- * `knowledge_base.py`: A simple knowledge base containing disposal information for different waste materials.
54
- * `requirements.txt`: A list of the Python dependencies required to run the application.
55
- * `test_images/`: A directory containing sample images for testing the 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(E2B) 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
+ ## 🛠️ Getting Started
29
 
30
  ### Prerequisites
31
 
32
+ * Python 3.9+
33
+ * Pip
34
+ * Cuda (optional)
35
 
36
  ### Installation
37
 
38
  1. Clone the repository:
39
  ```bash
40
+ git clone [https://github.com/yichuan-huang/gemma3n-challenge](https://github.com/yichuan-huang/gemma3n-challenge)
41
  ```
42
  2. Navigate to the project directory:
43
  ```bash
 
53
  To start the application, run the following command:
54
 
55
  ```bash
56
+ python app.py