Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update heatmap and track example documentation and requirements #1727

Closed
wants to merge 3 commits into from
Closed

docs: update heatmap and track example documentation and requirements #1727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7db272e
docs: update heatmap and track example documentation and requirements
shuuse Dec 10, 2024
3ef32c7
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Dec 10, 2024
aa095ee
docs: update README with installation and usage improvements
shuuse Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions examples/heatmap_and_track/README.md
View file
Open in desktop
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
```
Comment on lines +53 to +59
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YOLO's weight file is automatically when you run the script we technically we don't files because YOLO's itself can download automatically


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
Comment on lines +61 to +76
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is pretty much show only how to run videe out and using default video file and downoad viddo

```

## © license
Expand Down
3 changes: 3 additions & 0 deletions examples/heatmap_and_track/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
supervision[assets]==0.19.0
ultralytics<=8.3.40
opencv-python>=4.8.0
numpy>=1.22.0
torch>=2.0.0
Comment on lines +3 to +5
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This packages already coming with ultralytics and supervision so it doesn't needs to be added.