Rageya commited on
Commit
46f34ae
ยท
verified ยท
1 Parent(s): 07e18be

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +50 -44
README.md CHANGED
@@ -32,25 +32,25 @@ Upload any road image and get instant visual annotations along with a structured
32
 
33
  ## ๐ŸŽฏ Damage Classes
34
 
35
- | Code | Class Name | Color |
36
- |------|--------------------|----------|
37
- | D00 | Longitudinal Crack | ๐Ÿ”ต Blue |
38
- | D10 | Transverse Crack | ๐ŸŸข Green |
39
- | D20 | Alligator Crack | ๐ŸŸ  Orange|
40
- | D40 | Pothole | ๐Ÿ”ด Red |
41
 
42
  ---
43
 
44
  ## ๐ŸŒ Supported Countries (Pothole Context)
45
 
46
- | Country | Pothole Density |
47
- |--------------------|--------------------------|
48
- | ๐Ÿ‡ฎ๐Ÿ‡ณ India | โฌ›โฌ›โฌ›โฌ›โฌ› Very High |
49
- | ๐Ÿ‡ณ๐Ÿ‡ด Norway | โฌ›โฌ›โฌ›โฌ› High |
50
- | ๐Ÿ‡บ๐Ÿ‡ธ United States | โฌ›โฌ›โฌ› Moderate |
51
- | ๐Ÿ‡จ๐Ÿ‡ฟ Czech Republic | โฌ›โฌ›โฌ› Moderate |
52
- | ๐Ÿ‡จ๐Ÿ‡ณ China | โฌ›โฌ› Low-Moderate |
53
- | ๐Ÿ‡ฏ๐Ÿ‡ต Japan | โฌ› Low |
54
 
55
  ---
56
 
@@ -69,40 +69,44 @@ Upload any road image and get instant visual annotations along with a structured
69
  ## ๐Ÿ“Š Output Explained
70
 
71
  ### Detection Summary
 
72
  A per-class breakdown table showing:
 
73
  - Count of each damage type detected
74
  - Percentage of total detections
75
 
76
  ### Pothole (D40) Report
77
 
78
- | Field | Description |
79
- |-------------------|--------------------------------------------------|
80
- | Pothole Count | Number of D40 boxes detected |
81
- | % of Detections | Proportion of potholes vs all damage |
82
- | Severity | Critical / Moderate / Low / None |
83
- | Avg Confidence | Mean confidence score for pothole boxes |
84
 
85
  **Severity thresholds:**
 
86
  - ๐Ÿ”ด **CRITICAL** โ€” Potholes > 30% of all detections โ†’ Immediate repair needed
87
  - ๐ŸŸ  **MODERATE** โ€” Potholes > 10% โ†’ Schedule maintenance
88
  - ๐ŸŸก **LOW** โ€” Any potholes detected โ†’ Monitor road surface
89
  - ๐ŸŸข **NONE DETECTED** โ€” Road surface OK
90
 
91
  ### Country Context
 
92
  Provides pothole density, dominant damage types, and data collection method for the selected country as documented in the RDD2022 dataset.
93
 
94
  ---
95
 
96
  ## ๐Ÿง  Model Details
97
 
98
- | Property | Value |
99
- |----------------|--------------------------|
100
- | Architecture | YOLOv8s (small) |
101
- | Weights file | `yolov8s_best.pt` |
102
- | Input size | 640 ร— 640 px |
103
- | Classes | 4 (D00, D10, D20, D40) |
104
- | Framework | Ultralytics YOLOv8 |
105
- | Device | CUDA (GPU) / CPU fallback|
106
 
107
  ---
108
 
@@ -116,22 +120,23 @@ Provides pothole density, dominant damage types, and data collection method for
116
  ---
117
 
118
  ## ๐Ÿ—‚๏ธ Repository Structure
 
 
119
  Automated-Road-Damage-Detection/
120
- โ”œโ”€โ”€ app.py # Gradio UI + inference pipeline
121
- โ”œโ”€โ”€ predict.py # Standalone prediction script
122
- โ”œโ”€โ”€ yolov8s_best.pt # Fine-tuned YOLOv8s weights (22.5 MB)
123
- โ”œโ”€โ”€ rdd2022.yaml # Dataset config (class names, paths)
124
- โ”œโ”€โ”€ requirements.txt # Python dependencies
125
- โ”œโ”€โ”€ examples/ # Sample road images (6 countries)
126
- โ”‚ โ”œโ”€โ”€ india_test_image.jpg
127
- โ”‚ โ”œโ”€โ”€ China_Drone_000253.jpg
128
- โ”‚ โ”œโ”€โ”€ United_States_004798.jpg
129
- โ”‚ โ”œโ”€โ”€ Czech_test_image.jpg
130
- โ”‚ โ”œโ”€โ”€ China_Drone_000295.jpg
131
- โ”‚ โ””โ”€โ”€ norway_road_test.jpg
132
  โ””โ”€โ”€ README.md
133
-
134
- text
135
 
136
  ---
137
 
@@ -154,6 +159,8 @@ The app will be available at `http://localhost:7860`.
154
  ---
155
 
156
  ## ๐Ÿ“ฆ Requirements
 
 
157
  gradio>=4.0
158
  ultralytics
159
  torch
@@ -161,8 +168,7 @@ torchvision
161
  numpy
162
  Pillow
163
  opencv-python
164
-
165
- text
166
 
167
  ---
168
 
 
32
 
33
  ## ๐ŸŽฏ Damage Classes
34
 
35
+ | Code | Class Name | Color |
36
+ |------|---------------------|------------|
37
+ | D00 | Longitudinal Crack | ๐Ÿ”ต Blue |
38
+ | D10 | Transverse Crack | ๐ŸŸข Green |
39
+ | D20 | Alligator Crack | ๐ŸŸ  Orange |
40
+ | D40 | Pothole | ๐Ÿ”ด Red |
41
 
42
  ---
43
 
44
  ## ๐ŸŒ Supported Countries (Pothole Context)
45
 
46
+ | Country | Pothole Density |
47
+ |-------------------|------------------------|
48
+ | ๐Ÿ‡ฎ๐Ÿ‡ณ India | โฌ›โฌ›โฌ› Very High |
49
+ | ๐Ÿ‡ณ๐Ÿ‡ด Norway | โฌ›โฌ›โฌ› High |
50
+ | ๐Ÿ‡บ๐Ÿ‡ธ United States | โฌ›โฌ›โฌ› Moderate |
51
+ | ๐Ÿ‡จ๐Ÿ‡ฟ Czech Republic | โฌ›โฌ›โฌ› Moderate |
52
+ | ๐Ÿ‡จ๐Ÿ‡ณ China | โฌ›โฌ› Low-Moderate |
53
+ | ๐Ÿ‡ฏ๐Ÿ‡ต Japan | โฌ› Low |
54
 
55
  ---
56
 
 
69
  ## ๐Ÿ“Š Output Explained
70
 
71
  ### Detection Summary
72
+
73
  A per-class breakdown table showing:
74
+
75
  - Count of each damage type detected
76
  - Percentage of total detections
77
 
78
  ### Pothole (D40) Report
79
 
80
+ | Field | Description |
81
+ |------------------|------------------------------------------------|
82
+ | Pothole Count | Number of D40 boxes detected |
83
+ | % of Detections | Proportion of potholes vs all damage |
84
+ | Severity | Critical / Moderate / Low / None |
85
+ | Avg Confidence | Mean confidence score for pothole boxes |
86
 
87
  **Severity thresholds:**
88
+
89
  - ๐Ÿ”ด **CRITICAL** โ€” Potholes > 30% of all detections โ†’ Immediate repair needed
90
  - ๐ŸŸ  **MODERATE** โ€” Potholes > 10% โ†’ Schedule maintenance
91
  - ๐ŸŸก **LOW** โ€” Any potholes detected โ†’ Monitor road surface
92
  - ๐ŸŸข **NONE DETECTED** โ€” Road surface OK
93
 
94
  ### Country Context
95
+
96
  Provides pothole density, dominant damage types, and data collection method for the selected country as documented in the RDD2022 dataset.
97
 
98
  ---
99
 
100
  ## ๐Ÿง  Model Details
101
 
102
+ | Property | Value |
103
+ |---------------|---------------------------|
104
+ | Architecture | YOLOv8s (small) |
105
+ | Weights file | `yolov8s_best.pt` |
106
+ | Input size | 640 ร— 640 px |
107
+ | Classes | 4 (D00, D10, D20, D40) |
108
+ | Framework | Ultralytics YOLOv8 |
109
+ | Device | CUDA (GPU) / CPU fallback |
110
 
111
  ---
112
 
 
120
  ---
121
 
122
  ## ๐Ÿ—‚๏ธ Repository Structure
123
+
124
+ ```text
125
  Automated-Road-Damage-Detection/
126
+ โ”œโ”€โ”€ app.py # Gradio UI + inference pipeline
127
+ โ”œโ”€โ”€ predict.py # Standalone prediction script
128
+ โ”œโ”€โ”€ yolov8s_best.pt # Fine-tuned YOLOv8s weights (22.5 MB)
129
+ โ”œโ”€โ”€ rdd2022.yaml # Dataset config (class names, paths)
130
+ โ”œโ”€โ”€ requirements.txt # Python dependencies
131
+ โ”œโ”€โ”€ examples/ # Sample road images (6 countries)
132
+ โ”‚ โ”œโ”€โ”€ india_test_image.jpg
133
+ โ”‚ โ”œโ”€โ”€ China_Drone_000253.jpg
134
+ โ”‚ โ”œโ”€โ”€ United_States_004798.jpg
135
+ โ”‚ โ”œโ”€โ”€ Czech_test_image.jpg
136
+ โ”‚ โ”œโ”€โ”€ China_Drone_000295.jpg
137
+ โ”‚ โ””โ”€โ”€ norway_road_test.jpg
138
  โ””โ”€โ”€ README.md
139
+ ```
 
140
 
141
  ---
142
 
 
159
  ---
160
 
161
  ## ๐Ÿ“ฆ Requirements
162
+
163
+ ```text
164
  gradio>=4.0
165
  ultralytics
166
  torch
 
168
  numpy
169
  Pillow
170
  opencv-python
171
+ ```
 
172
 
173
  ---
174