Skip to content

Commit aa095ee

Browse files
committed
docs: update README with installation and usage improvements
1 parent 3ef32c7 commit aa095ee

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

examples/heatmap_and_track/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,30 @@ supervision package for multiple tasks such as drawing heatmap annotations, trac
5050

5151
## ⚙️ run
5252

53+
Before running the script, make sure to download the YOLO weights:
5354
```bash
55+
# Download YOLOv8n weights (if you don't have your own weights file)
56+
wget https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt -O weight.pt
57+
# Or using curl
58+
curl -L https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt -o weight.pt
59+
```
60+
61+
Then run the script:
62+
```bash
63+
# Run with default demo video (people-walking.mp4)
64+
python script.py \
65+
--source_weights_path weight.pt \
66+
--confidence_threshold 0.3 \
67+
--iou_threshold 0.5 \
68+
--target_video_path output_video.mp4
69+
70+
# Or run with your own video file
5471
python script.py \
5572
--source_weights_path weight.pt \
56-
--source_video_path input_video.mp4 \
73+
--source_video_path your_video.mp4 \
5774
--confidence_threshold 0.3 \
5875
--iou_threshold 0.5 \
59-
--target_video_path output_video.mp4
76+
--target_video_path output_video.mp4
6077
```
6178

6279
## © license

0 commit comments

Comments
 (0)