santit96 commited on
Commit
6802b2f
·
1 Parent(s): fa84113

Update readme

Browse files
Files changed (1) hide show
  1. README.md +47 -1
README.md CHANGED
@@ -11,4 +11,50 @@ pinned: false
11
  Waste Classifier
12
  ==============================
13
 
14
- Waste Detection and Classifier tool
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  Waste Classifier
12
  ==============================
13
 
14
+ # Waste Classifier Streamlit App
15
+
16
+ ## Overview
17
+
18
+ The Waste Classifier Streamlit App is designed to detect waste in images using the EfficientDet and classify them with a fine-tuned resnet50 model into different classes. Users can upload an image containing trash, and the app will display both the uploaded and classified images in parallel columns.
19
+
20
+ ## Instructions
21
+
22
+ ### Installation
23
+
24
+ Make sure you have Python installed. Clone the repository and navigate to the project directory:
25
+
26
+ ```bash
27
+ git clone <repository_url>
28
+ cd <project_directory>
29
+ ```
30
+
31
+ Create a virtual environment and install dependencies:
32
+
33
+ ```bash
34
+ python -m venv venv-waste-classifier
35
+ source venv-waste-classifier/bin/activate # On Windows, use 'venv-waste-classifier\Scripts\activate'
36
+ pip install -r requirements.txt
37
+ ```
38
+
39
+ ### Running the App
40
+
41
+ Execute the Streamlit app with the following command:
42
+
43
+ ```bash
44
+ streamlit run app.py
45
+ ```
46
+
47
+ This will launch a local development server, and you can access the app in your web browser at `http://localhost:8501`.
48
+
49
+ ### Usage
50
+
51
+ 1. Upload an image with trash using the provided file uploader.
52
+ 2. The app will display the uploaded image in the left column.
53
+ 3. Click the "Classify trash" button to initiate the classification process.
54
+ 4. The classified image will be displayed in the right column.
55
+
56
+ ## Dependencies
57
+
58
+ - Streamlit
59
+ - Pillow
60
+ - Other dependencies as specified in the `requirements.txt` file.