DeepActionPotential commited on
Commit
99b5d17
·
verified ·
1 Parent(s): a4dd111

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +108 -97
README.md CHANGED
@@ -1,97 +1,108 @@
1
- # LeafNet - Healyth vs unhealthy tea classifier
2
- *A deep learning tool to classify tea leaves as healthy or unhealthy from images.*
3
-
4
- ![MIT License](https://img.shields.io/badge/license-MIT-green)
5
-
6
- ---
7
-
8
- ## Table of Contents
9
-
10
- - [Demo](#demo)
11
- - [Features](#features)
12
- - [Installation / Setup](#installation--setup)
13
- - [Usage](#usage)
14
- - [Configuration / Options](#configuration--options)
15
- - [Contributing](#contributing)
16
- - [License](#license)
17
- - [Acknowledgements / Credits](#acknowledgements--credits)
18
-
19
- ---
20
-
21
- ## Demo
22
-
23
- ![Demo Screenshot](./demo/demo.png)
24
- *Main interface for uploading and classifying tea leaf images.*
25
-
26
- ![Demo Video](./demo/demo.mp4)
27
- *Video walkthrough of the classification workflow.*
28
-
29
- ---
30
-
31
- ## Features
32
-
33
- - Classifies tea leaf images as healthy or unhealthy using deep learning.
34
- - Simple, interactive web-based UI for image upload and prediction.
35
- - Modular codebase for easy extension and retraining.
36
- - Fast inference for both single and batch image processing.
37
-
38
- ---
39
-
40
- ## Installation / Setup
41
-
42
- ```bash
43
- # Create a virtual environment
44
- python -m venv .venv
45
-
46
- # Activate it
47
- # On Linux/Mac:
48
- source .venv/bin/activate
49
- # On Windows:
50
- .venv\Scripts\activate
51
-
52
- # Install dependencies
53
- pip install -r requirements.txt
54
- ```
55
-
56
- ---
57
-
58
- ## Usage
59
-
60
- Run the application:
61
-
62
- ```bash
63
- python app.py
64
- ```
65
-
66
- This will launch the web interface in your browser.
67
- Upload an image of a tea leaf to get a health classification.
68
-
69
- ---
70
-
71
- ## Configuration / Options
72
-
73
- - UI and model configuration can be adjusted in the source files.
74
- - For advanced settings (e.g., model path, thresholds), edit the relevant Python files.
75
-
76
- ---
77
-
78
- ## Contributing
79
-
80
- Contributions are welcome!
81
- - Open issues for bugs or feature requests.
82
- - Submit pull requests for improvements.
83
- - Please follow standard Python code style and include tests where possible.
84
-
85
- ---
86
-
87
- ## License
88
-
89
- This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
90
-
91
- ---
92
-
93
- ## Acknowledgements / Credits
94
-
95
- - Developed by Eslam Tarek.
96
- - Thanks to the open-source community for libraries and inspiration.
97
-
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: PlateVision YOLO-based License Plate Detection
3
+ emoji: 🚗
4
+ colorFrom: yellow
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ sdk_version: "1.40.0" # latest stable streamlit
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ *A deep learning tool to classify tea leaves as healthy or unhealthy from images.*
14
+
15
+ ![MIT License](https://img.shields.io/badge/license-MIT-green)
16
+
17
+ ---
18
+
19
+ ## Table of Contents
20
+
21
+ - [Demo](#demo)
22
+ - [Features](#features)
23
+ - [Installation / Setup](#installation--setup)
24
+ - [Usage](#usage)
25
+ - [Configuration / Options](#configuration--options)
26
+ - [Contributing](#contributing)
27
+ - [License](#license)
28
+ - [Acknowledgements / Credits](#acknowledgements--credits)
29
+
30
+ ---
31
+
32
+ ## Demo
33
+
34
+ ![Demo Screenshot](./demo/demo.png)
35
+ *Main interface for uploading and classifying tea leaf images.*
36
+
37
+ ![Demo Video](./demo/demo.mp4)
38
+ *Video walkthrough of the classification workflow.*
39
+
40
+ ---
41
+
42
+ ## Features
43
+
44
+ - Classifies tea leaf images as healthy or unhealthy using deep learning.
45
+ - Simple, interactive web-based UI for image upload and prediction.
46
+ - Modular codebase for easy extension and retraining.
47
+ - Fast inference for both single and batch image processing.
48
+
49
+ ---
50
+
51
+ ## Installation / Setup
52
+
53
+ ```bash
54
+ # Create a virtual environment
55
+ python -m venv .venv
56
+
57
+ # Activate it
58
+ # On Linux/Mac:
59
+ source .venv/bin/activate
60
+ # On Windows:
61
+ .venv\Scripts\activate
62
+
63
+ # Install dependencies
64
+ pip install -r requirements.txt
65
+ ```
66
+
67
+ ---
68
+
69
+ ## Usage
70
+
71
+ Run the application:
72
+
73
+ ```bash
74
+ python app.py
75
+ ```
76
+
77
+ This will launch the web interface in your browser.
78
+ Upload an image of a tea leaf to get a health classification.
79
+
80
+ ---
81
+
82
+ ## Configuration / Options
83
+
84
+ - UI and model configuration can be adjusted in the source files.
85
+ - For advanced settings (e.g., model path, thresholds), edit the relevant Python files.
86
+
87
+ ---
88
+
89
+ ## Contributing
90
+
91
+ Contributions are welcome!
92
+ - Open issues for bugs or feature requests.
93
+ - Submit pull requests for improvements.
94
+ - Please follow standard Python code style and include tests where possible.
95
+
96
+ ---
97
+
98
+ ## License
99
+
100
+ This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
101
+
102
+ ---
103
+
104
+ ## Acknowledgements / Credits
105
+
106
+ - Developed by Eslam Tarek.
107
+ - Thanks to the open-source community for libraries and inspiration.
108
+