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.

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

Conversation

shuuse
Copy link

@shuuse shuuse commented Dec 10, 2024

Description

This PR updates the Heatmap and track example documentation and requirements to improve user experience and clarity.

Changes made:

  • Added detailed run instructions with helpful comments
  • Updated requirements.txt with all necessary dependencies
  • Added instructions for downloading YOLO weights

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How has this change been tested?

  • Tested the installation process with fresh Python 3.10, 3.11, 3.12
  • Verified all dependencies are correctly listed
  • Tested the run commands with both default and custom videos
  • Verified the YOLO weights download process

Any specific deployment considerations

  • No special deployment considerations required
  • All changes are documentation and requirements updates
  • No impact on existing functionality

Docs

  • Docs updated? What were the changes:
    • Updated README.md in heatmap_and_track example
    • Updated requirements.txt with complete dependency list

- Add detailed run instructions with comments
- Update requirements.txt with all necessary dependencies
- Add instructions for downloading YOLO weights
@CLAassistant
Copy link

CLAassistant commented Dec 10, 2024

CLA assistant check
All committers have signed the CLA.

@onuralpszr
Copy link
Collaborator

@shuuse did you push everything ?

@shuuse
Copy link
Author

shuuse commented Dec 10, 2024

@shuuse did you push everything ?
@onuralpszr Now, I did 👍

Copy link
Collaborator

@onuralpszr onuralpszr left a comment

Choose a reason for hiding this comment

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

Helo.l this or not enough merge it 👍 I am sorry, I am closing the PR, feel free to open If this PR If you have question or you can open new for feature them I am happy to ask well.

Onurlp S.
Mechatronic Engineering

Comment on lines +3 to +5
opencv-python>=4.8.0
numpy>=1.22.0
torch>=2.0.0
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.

Comment on lines +53 to +59
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
```
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

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

@onuralpszr onuralpszr closed this Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants