Jeremy341 commited on
Commit
d18d05b
·
verified ·
1 Parent(s): 6196af0

update readme to be good

Browse files
Files changed (1) hide show
  1. README.md +31 -87
README.md CHANGED
@@ -1,4 +1,4 @@
1
- ```md
2
  ---
3
  license: mit
4
  library_name: ultralytics
@@ -19,21 +19,9 @@ datasets:
19
  - garythung/trashnet
20
  ---
21
 
22
- # MIRA — Machine Intelligence for Recycling Automation
23
-
24
- MIRA is a computer-vision project for recognizing waste materials and preparing
25
- the results for future automated sorting.
26
-
27
- The project was developed for Jugend forscht. The long-term goal is to connect
28
- the vision system to a robot or sorting mechanism. Raspberry Pi deployment and
29
- physical sorting are still future work.
30
-
31
- - GitHub: https://github.com/jeremy341/MIRA-AI
32
- - Project website: https://mira-vision.vercel.app/
33
 
34
- ## What the models detect
35
-
36
- All detection models use five classes:
37
 
38
  - glass
39
  - metal
@@ -41,36 +29,24 @@ All detection models use five classes:
41
  - plastic
42
  - trash
43
 
44
- ## Model files
45
-
46
- This repository contains models and exports from several experiments:
47
-
48
- | File type | Description |
49
- |---|---|
50
- | `.pt` | Ultralytics YOLO/PyTorch models |
51
- | `.onnx` | ONNX exports |
52
- | `.tflite` | Quantized LiteRT/TFLite exports |
53
 
54
- The recommended current detector is:
55
-
56
- ```text
57
- mira_exp019.pt
58
- ```
59
 
60
- The EXP-019 exports are:
61
 
62
- | File | Description |
63
- |---|---|
64
- | `mira_exp019.pt` | Main YOLO11n detector |
65
- | `mira_exp019.onnx` | ONNX export |
66
- | `mira_exp019_int8_320.tflite` | INT8 TFLite export at 320 px |
67
- | `mira_exp019_int8_640.tflite` | INT8 TFLite export at 640 px |
68
 
69
  ## Experiment results
70
 
71
- The main detection experiments produced the following results:
72
-
73
- | Experiment | Model | Dataset setup | mAP50 |
74
  |---|---|---|---:|
75
  | EXP-005 | YOLOv8n | Custom + TrashNet | 82.3% |
76
  | EXP-006 | YOLOv8n | Fused Wild + TrashNet | 39.4% |
@@ -84,17 +60,11 @@ The main detection experiments produced the following results:
84
  | EXP-018 | YOLO11n | Clean balanced dataset | 90.6% |
85
  | EXP-019 | YOLO11n | Clean balanced repeatability run | 90.58% |
86
 
87
- The main result was that adding more data did not automatically improve the
88
- model. Some larger combinations contained inconsistent image styles, labels,
89
- and object arrangements.
90
 
91
- After removing unsuitable data and creating a cleaner, more balanced dataset,
92
- the detector improved substantially. EXP-019 repeated the result from EXP-018
93
- closely.
94
-
95
- ## EXP-019 evaluation
96
-
97
- The recorded EXP-019 metrics are:
98
 
99
  | Metric | Result |
100
  |---|---:|
@@ -105,77 +75,51 @@ The recorded EXP-019 metrics are:
105
  | Training images | 5,108 |
106
  | Validation images | 415 |
107
  | Test images | 1,375 |
108
- | Training time | 2.672 hours |
109
- | Hardware | NVIDIA Tesla T4 |
110
 
111
- These results come from the project’s validation and evaluation setup. They
112
- should not be interpreted as completed real-world or robotic-sorting
113
- performance.
114
 
115
  ## Usage
116
 
117
- Download a model file and install Ultralytics:
118
 
119
  ```bash
120
  pip install ultralytics
121
  ```
122
 
123
- Load the model and run prediction:
124
 
125
  ```python
126
  from ultralytics import YOLO
127
 
128
  model = YOLO("mira_exp019.pt")
129
-
130
- results = model.predict(
131
- source="image.jpg",
132
- conf=0.25,
133
- save=True,
134
- )
135
  ```
136
 
137
- For validation, a compatible YOLO dataset YAML is required:
138
 
139
  ```python
140
  results = model.val(data="dataset.yaml")
141
  ```
142
 
143
- The MIRA repository provides the full CLI, webcam interface, dashboard,
144
- dataset tools, and download commands:
145
-
146
- ```powershell
147
- mira download mira_exp019.pt
148
- mira live --model mira_exp019.pt
149
- mira dashboard
150
- ```
151
-
152
  ## Datasets
153
 
154
- The project used combinations of:
155
 
156
  - [dmedhi garbage image classification/detection](https://huggingface.co/datasets/dmedhi/garbage-image-classification-detection)
157
  - [TACO](https://github.com/pedropro/TACO)
158
  - [TrashNet](https://github.com/garythung/trashnet)
159
  - Roboflow waste-detection data
160
 
161
- The datasets were remapped to the five MIRA classes. Dataset licenses and
162
- source details are documented in the
163
- [GitHub repository](https://github.com/jeremy341/MIRA-AI/blob/main/docs/DATASET_ORIGINS.md).
164
 
165
  ## Limitations
166
 
167
- The current models can struggle with:
168
-
169
- - white crumpled paper
170
- - cans viewed from the opening
171
- - strongly overlapping objects
172
- - unusual lighting and object arrangements
173
-
174
- Raspberry Pi latency, memory use, and complete physical sorting have not yet
175
- been fully tested.
176
 
177
  ## License
178
 
179
- The project code and model files are released under the MIT License where
180
- applicable. Dataset licenses remain subject to their original terms.
181
  ```
 
1
+
2
  ---
3
  license: mit
4
  library_name: ultralytics
 
19
  - garythung/trashnet
20
  ---
21
 
22
+ # MIRA — Waste Detection Models
 
 
 
 
 
 
 
 
 
 
23
 
24
+ MIRA is a computer-vision project for detecting five types of waste:
 
 
25
 
26
  - glass
27
  - metal
 
29
  - plastic
30
  - trash
31
 
32
+ This repository contains the trained models and exports from the MIRA
33
+ experiments. The recommended model is `mira_exp019.pt`.
 
 
 
 
 
 
 
34
 
35
+ - GitHub: https://github.com/jeremy341/MIRA-AI
36
+ - Project website: https://mira-vision.vercel.app/
 
 
 
37
 
38
+ ## Recommended model
39
 
40
+ | File | Format | Description |
41
+ |---|---|---|
42
+ | `mira_exp019.pt` | PyTorch | Recommended YOLO11n detector |
43
+ | `mira_exp019.onnx` | ONNX | ONNX export of EXP-019 |
44
+ | `mira_exp019_int8_320.tflite` | TFLite | INT8 export at 320 px |
45
+ | `mira_exp019_int8_640.tflite` | TFLite | INT8 export at 640 px |
46
 
47
  ## Experiment results
48
 
49
+ | Experiment | Model | Dataset | mAP50 |
 
 
50
  |---|---|---|---:|
51
  | EXP-005 | YOLOv8n | Custom + TrashNet | 82.3% |
52
  | EXP-006 | YOLOv8n | Fused Wild + TrashNet | 39.4% |
 
60
  | EXP-018 | YOLO11n | Clean balanced dataset | 90.6% |
61
  | EXP-019 | YOLO11n | Clean balanced repeatability run | 90.58% |
62
 
63
+ The main finding was that more data did not automatically produce better
64
+ results. Removing inconsistent data and building a cleaner, balanced dataset
65
+ led to the strongest results in EXP-018 and EXP-019.
66
 
67
+ ## EXP-019 metrics
 
 
 
 
 
 
68
 
69
  | Metric | Result |
70
  |---|---:|
 
75
  | Training images | 5,108 |
76
  | Validation images | 415 |
77
  | Test images | 1,375 |
 
 
78
 
79
+ These results come from the project’s recorded evaluation setup.
 
 
80
 
81
  ## Usage
82
 
83
+ Install Ultralytics:
84
 
85
  ```bash
86
  pip install ultralytics
87
  ```
88
 
89
+ Download `mira_exp019.pt` from this repository and run inference:
90
 
91
  ```python
92
  from ultralytics import YOLO
93
 
94
  model = YOLO("mira_exp019.pt")
95
+ results = model.predict("image.jpg", conf=0.25, save=True)
 
 
 
 
 
96
  ```
97
 
98
+ For validation, provide a compatible YOLO dataset configuration:
99
 
100
  ```python
101
  results = model.val(data="dataset.yaml")
102
  ```
103
 
 
 
 
 
 
 
 
 
 
104
  ## Datasets
105
 
106
+ The models were trained using combinations of:
107
 
108
  - [dmedhi garbage image classification/detection](https://huggingface.co/datasets/dmedhi/garbage-image-classification-detection)
109
  - [TACO](https://github.com/pedropro/TACO)
110
  - [TrashNet](https://github.com/garythung/trashnet)
111
  - Roboflow waste-detection data
112
 
113
+ The datasets were remapped to the five MIRA classes. Their original licenses
114
+ and sources remain applicable.
 
115
 
116
  ## Limitations
117
 
118
+ The models can struggle with crumpled paper, cans viewed from the opening,
119
+ overlapping objects, and unusual image conditions.
 
 
 
 
 
 
 
120
 
121
  ## License
122
 
123
+ The model files are provided under the MIT License where applicable. Dataset
124
+ licenses remain subject to their original terms.
125
  ```