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

Add package-segmentation dataset notebook #26

Merged
merged 10 commits into from
Jan 8, 2025
Merged

Conversation

RizwanMunawar
Copy link
Member

@RizwanMunawar RizwanMunawar commented Jan 8, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This PR makes updates to existing object-counting and heatmap-generation notebooks, introduces a new notebook for tracking objects within specific zones using YOLO, and provides another detailed notebook for training YOLO on a package segmentation dataset.

📊 Key Changes

  • 🔄 File Renaming in Notebooks: Updated output filenames in object-counting and heatmap-generation notebooks for better clarity (object_counting_output.avi -> counting.avi and heatmap_output.avi -> heatmap.avi).
  • 🆕 New Tracking Notebook: Added a "TrackZone" notebook that demonstrates tracking objects within user-defined zones on videos or streams using YOLO's tracking system.
  • 🆕 New Segmentation Training Notebook: Introduced a notebook guiding users on training the YOLO model for package segmentation with specific datasets such as detecting packages in logistics scenarios.

🎯 Purpose & Impact

  • Improved Usability: 🔧 Renaming output files ensures easier recognition and alignment with the content of the notebooks.
  • New Tracking Functionality: 🔍 The "TrackZone" notebook facilitates advanced, zone-specific object tracking, ideal for applications like surveillance or crowd monitoring.
  • Specialized Training: 📦 The package segmentation notebook provides a practical learning resource for training YOLO in real-world tasks like eCommerce packaging quality checks and logistic optimization.

This update brings more structured examples to users and enables more diverse usage of YOLO models for tracking, segmentation, and targeted analysis. 🌟

Signed-off-by: Muhammad Rizwan Munawar <[email protected]>
@RizwanMunawar RizwanMunawar requested review from ambitious-octopus and removed request for ambitious-octopus January 8, 2025 14:49
@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation exports Model exports (ONNX, TensorRT, TFLite, etc.) segment Instance Segmentation issues, PR's labels Jan 8, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @RizwanMunawar, thank you for submitting your ultralytics/notebooks 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Make sure to clearly summarize the purpose of your addition in your PR description. Linking to any relevant issues or discussions could also help the maintainers better understand your changes.
  • Synchronize with Source: Ensure your PR is synchronized with the main branch of the ultralytics/notebooks repository. If it’s lagging behind, you can update it by clicking the 'Update branch' button on GitHub or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify that all Ultralytics Continuous Integration (CI) checks pass. If any CI jobs fail, kindly troubleshoot and address those issues 💪.
  • Update Documentation: If your code introduces new functionality or modifies existing features, be sure to update the documentation accordingly.
  • Add Tests: Test coverage is essential for any new features or fixes. If applicable, kindly include or update relevant tests to ensure continued stability. Confirm that all tests pass before submitting.
  • Sign the CLA: If this is your first contribution to an Ultralytics project, please review and sign our Contributor License Agreement (CLA) by adding the following comment to this PR: I have read the CLA Document and I sign the CLA.
  • Minimize Changes: Keep your changes limited to what is necessary to achieve the core objective of your pull request. As Bruce Lee said, "Hack away the unessential." ✂️

For more information and guidelines on contributing to Ultralytics, please refer to our Contributing Guide. If you have any questions or run into issues, don’t hesitate to leave a comment here, and one of our engineers will assist you shortly 🚀.

Thank you for contributing with this great addition—a step-by-step notebook for using YOLO11 with a package segmentation dataset sounds super exciting! 🙌

Copy link
Member

@ambitious-octopus ambitious-octopus left a comment

Choose a reason for hiding this comment

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

@RizwanMunawar please remove the hard-coded checkout:

!rm -rf ultralytics
!git clone https://github.com/ultralytics/ultralytics
%cd ultralytics
!git checkout "RizwanMunawar-patch-1"
!pip install -e .

Copy link
Member

@ambitious-octopus ambitious-octopus left a comment

Choose a reason for hiding this comment

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

Don't forget to fix later @RizwanMunawar !

Signed-off-by: Muhammad Rizwan Munawar <[email protected]>
@RizwanMunawar RizwanMunawar merged commit 8c216ca into main Jan 8, 2025
1 check passed
@RizwanMunawar RizwanMunawar deleted the RizwanMunawar-patch-1 branch January 8, 2025 16:03
@UltralyticsAssistant
Copy link
Member

🎉 Great news! Your PR has been merged! 🎉

Huge thanks to @RizwanMunawar for leading this and @ambitious-octopus for your valuable contributions. Your enhancements to the object-counting and heatmap notebooks, along with introducing the incredible zone-specific tracking and segmentation tools, are gifts to the community. These updates will empower countless users to unlock new possibilities with YOLO’s capabilities. 🚀

As Marcus Aurelius once said, "What we do now echoes in eternity." Your work isn’t just code—it’s a spark that will inspire innovation in fields from logistics to surveillance, making a tangible impact in the real world. 🌟

Keep shining and thank you for coding with purpose and passion. ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation exports Model exports (ONNX, TensorRT, TFLite, etc.) segment Instance Segmentation issues, PR's
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants