Skip to content

Commit

Permalink
docs: update README with installation and usage improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
shuuse committed Dec 10, 2024
1 parent 3ef32c7 commit aa095ee
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions examples/heatmap_and_track/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,30 @@ supervision package for multiple tasks such as drawing heatmap annotations, trac

## ⚙️ run

Before running the script, make sure to download the YOLO weights:
```bash
# Download YOLOv8n weights (if you don't have your own weights file)
wget https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt -O weight.pt
# Or using curl
curl -L https://github.com/ultralytics/assets/releases/download/v0.0.0/yolov8n.pt -o weight.pt
```

Then run the script:
```bash
# Run with default demo video (people-walking.mp4)
python script.py \
--source_weights_path weight.pt \
--confidence_threshold 0.3 \
--iou_threshold 0.5 \
--target_video_path output_video.mp4
# Or run with your own video file
python script.py \
--source_weights_path weight.pt \
--source_video_path input_video.mp4 \
--source_video_path your_video.mp4 \
--confidence_threshold 0.3 \
--iou_threshold 0.5 \
--target_video_path output_video.mp4
--target_video_path output_video.mp4
```

## © license
Expand Down

0 comments on commit aa095ee

Please sign in to comment.