Skip to content

Add tqdm progress bar for image datasets and improve CLI help in detect.py #IEEESOC #13605

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

U-m-4r
Copy link

@U-m-4r U-m-4r commented May 26, 2025

This PR enhances the user experience of [detect.py] by:

  • Adding a progress bar (via tqdm) when processing image datasets, making it easier to monitor inference progress on large sets of images.

image

  • Improving the command-line interface with a descriptive description and epilog in the argument parser, including a clear usage example.
  • All changes are backward compatible and do not affect detection logic or outputs.
  • These improvements make the script more user-friendly and approachable, especially for new users and those working with large datasets.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This update adds a progress bar for image processing and improves the command-line help for YOLOv5 detection, making the tool more user-friendly. 🚀

📊 Key Changes

  • Integrated a progress bar (using tqdm) when processing images, showing real-time progress.
  • Enhanced the command-line interface with a description and usage example for easier understanding.

🎯 Purpose & Impact

  • Better User Experience: Users now see a visual progress bar when running detection on images, making it easier to track progress. ⏳
  • Improved Usability: Clearer command-line help and examples make it simpler for new and existing users to understand how to use the detection script. 📝
  • No Impact on Results: These changes do not affect detection accuracy or performance, only the user interface and experience.

Copy link
Contributor

github-actions bot commented May 26, 2025

All Contributors have signed the CLA. ✅
Posted by the CLA Assistant Lite bot.

@UltralyticsAssistant UltralyticsAssistant added detect Object Detection issues, PR's documentation Improvements or additions to documentation enhancement New feature or request labels May 26, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @U-m-4r, thank you for submitting an ultralytics/yolov5 🚀 PR! This is an automated response to help streamline the review process. An Ultralytics engineer will also assist you soon.

Please review the following checklist to ensure a smooth integration of your enhancements:

  • Define a Purpose: Clearly explain the purpose of your improvements in your PR description and link any relevant issues. Make sure your commit messages are clear and follow project conventions.
  • Synchronize with Source: Confirm your PR is up to date with the ultralytics/yolov5 main branch. If not, use the 'Update branch' button or run git pull and git merge main locally.
  • Ensure CI Checks Pass: Check that all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address them.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, add or update tests for your changes and verify that all tests pass.
  • Sign the CLA: Ensure you have signed the Contributor License Agreement (CLA) if this is your first PR by commenting "I have read the CLA Document and I sign the CLA" below.
  • Minimize Changes: Limit your changes to the minimum necessary for your feature addition or bug fix. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more details, please refer to our Contributing Guide. If you have any questions, feel free to comment here. Thanks for helping make YOLOv5 even better! 🎉🛠️

@U-m-4r
Copy link
Author

U-m-4r commented May 26, 2025

I have read the CLA Document and I sign the CLA

@U-m-4r U-m-4r closed this May 26, 2025
@U-m-4r U-m-4r reopened this May 26, 2025
@U-m-4r U-m-4r changed the title Add tqdm progress bar for image datasets and improve CLI help in detect.py Add tqdm progress bar for image datasets and improve CLI help in detect.py #IEEESOC May 26, 2025
@U-m-4r
Copy link
Author

U-m-4r commented May 27, 2025

@glenn-jocher At least 1 approving review is required :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
detect Object Detection issues, PR's documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants