Skip to content

Commit 02f1d07

Browse files
committed
docs (vision-track): prettier fmt fix
1 parent 26422db commit 02f1d07

File tree

2 files changed

+61
-61
lines changed

2 files changed

+61
-61
lines changed

subjects/ai/vision-track/README.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -90,68 +90,67 @@ To ensure project completeness and audit validation, include the following:
9090

9191
1. **Model Artifacts**:
9292
- Save all trained and optimized YOLO model weights in:
93-
```
94-
models/checkpoints/
95-
├── best.pt
96-
├── best_quantized.onnx
97-
└── config.yaml
98-
```
93+
```
94+
models/checkpoints/
95+
├── best.pt
96+
├── best_quantized.onnx
97+
└── config.yaml
98+
```
9999
- Include logs or configuration files documenting training and optimization steps.
100100
101101
2. **Evaluation Metrics**:
102102
- Generate and save a report file:
103-
reports/performance_metrics.json
103+
reports/performance_metrics.json
104104
- Example format:
105-
```json
106-
{
107-
"detection_precision": 0.92,
108-
"detection_recall": 0.90,
109-
"f1_score": 0.91,
110-
"average_fps_per_stream": 18.5,
111-
"average_latency_ms": 85.0
112-
}
113-
```
105+
```json
106+
{
107+
"detection_precision": 0.92,
108+
"detection_recall": 0.9,
109+
"f1_score": 0.91,
110+
"average_fps_per_stream": 18.5,
111+
"average_latency_ms": 85.0
112+
}
113+
```
114114
- Minimum passing thresholds:
115-
Precision ≥ 0.85
116-
Recall ≥ 0.80
117-
F1-score ≥ 0.85
118-
Average FPS ≥ 15 (for 720p video)
115+
Precision ≥ 0.85
116+
Recall ≥ 0.80
117+
F1-score ≥ 0.85
118+
Average FPS ≥ 15 (for 720p video)
119119
120120
3. **Real-Time App Test**
121121
- The app must run using:
122-
```
123-
streamlit run app.py
124-
```
122+
```
123+
streamlit run app.py
124+
```
125125
- The app should:
126-
Display real-time detection overlays and FPS/latency counters.
127-
Allow toggling of detection and tracking features per stream.
128-
Handle missing or broken video sources gracefully.
126+
Display real-time detection overlays and FPS/latency counters.
127+
Allow toggling of detection and tracking features per stream.
128+
Handle missing or broken video sources gracefully.
129129
130130
4. **ROI Counting Validation**
131131
- Demonstrate ROI-based counting of people entering/exiting the region.
132132
- Save examples in:
133-
```
134-
reports/demo_results/
135-
├── roi_counting_example.png
136-
└── multi_stream_demo.mp4
137-
```
133+
```
134+
reports/demo_results/
135+
├── roi_counting_example.png
136+
└── multi_stream_demo.mp4
137+
```
138138
139139
5. **GPU and Fallback Test**
140140
- Check for CUDA availability in your code:
141-
```
142-
import torch
143-
print("Using CUDA:", torch.cuda.is_available())
144-
```
141+
```
142+
import torch
143+
print("Using CUDA:", torch.cuda.is_available())
144+
```
145145
- The app must still run on CPU if CUDA is unavailable (with lower FPS
146146
147147
6. **Error Handling**
148-
149148
- The app must not crash on missing files or failed streams.
150149
151150
- Log errors to:
152-
```
153-
logs/app_errors.log
154-
```
151+
```
152+
logs/app_errors.log
153+
```
155154
156155
### Project Repository Structure
157156

subjects/ai/vision-track/audit/README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
###### Is the dataset loaded and preprocessed to remove anomalies, handle missing values, and prepare video/image frames for object detection and tracking?
1818

1919
###### Does data preprocessing include resizing and normalization, ensuring compatibility with YOLO model input formats?
20-
* Validation of YOLO-compatible annotations (.txt files with class, x, y, w, h).
21-
* Confirm frames are resized and normalized properly before inference.
20+
21+
- Validation of YOLO-compatible annotations (.txt files with class, x, y, w, h).
22+
- Confirm frames are resized and normalized properly before inference.
2223

2324
##### Model Implementation
2425

@@ -64,35 +65,35 @@
6465

6566
###### Check:
6667

67-
* Require metrics file:
68+
- Require metrics file:
6869

69-
```
70-
reports/performance_metrics.json
71-
```
70+
```
71+
reports/performance_metrics.json
72+
```
7273

73-
* Validate JSON includes:
74+
- Validate JSON includes:
7475

75-
```json
76-
{
77-
"detection_precision": ...,
78-
"detection_recall": ...,
79-
"f1_score": ...,
80-
"average_fps_per_stream": ...,
81-
"average_latency_ms": ...
82-
}
83-
```
76+
```json
77+
{
78+
"detection_precision": ...,
79+
"detection_recall": ...,
80+
"f1_score": ...,
81+
"average_fps_per_stream": ...,
82+
"average_latency_ms": ...
83+
}
84+
```
8485

85-
* Add minimum thresholds:
86+
- Add minimum thresholds:
8687

87-
Precision ≥ 0.85
88+
Precision ≥ 0.85
8889

89-
Recall ≥ 0.80
90+
Recall ≥ 0.80
9091

91-
F1 ≥ 0.85
92+
F1 ≥ 0.85
9293

93-
FPS ≥ 15 (720p)
94+
FPS ≥ 15 (720p)
9495

95-
* Add check that metrics are visible in Streamlit dashboard (FPS + latency shown live).
96+
- Add check that metrics are visible in Streamlit dashboard (FPS + latency shown live).
9697

9798
##### Additional Considerations
9899

0 commit comments

Comments
 (0)