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

Update README.md #19

Merged
merged 2 commits into from
Jan 5, 2025
Merged

Update README.md #19

merged 2 commits into from
Jan 5, 2025

Conversation

RizwanMunawar
Copy link
Member

@RizwanMunawar RizwanMunawar commented Jan 5, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Added a new reference section on core Ultralytics YOLO tasks and improved organization in the README documentation. πŸš€

πŸ“Š Key Changes

  • Added a new row in the table showcasing "Detect, Segment, Classify, Pose using Ultralytics YOLO," linking to a unified tutorial for multiple tasks.
  • Updated corresponding links to a sample Colab notebook, YouTube tutorial, and discussion page related to general YOLO tasks.
  • Kept existing notebooks and topics intact while introducing a broader, task-oriented focus.

🎯 Purpose & Impact

  • Purpose: To provide a more comprehensive entry point for users interested in exploring various YOLO functionalities (detection, segmentation, etc.) in a single tutorial.
  • Impact: Enhances the readability of the README and makes it easier for users to find resources for the complete range of YOLO tasks. It simplifies access, improves user learning curves, and supports more seamless project execution.

Signed-off-by: Muhammad Rizwan Munawar <[email protected]>
@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 5, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @RizwanMunawar, thank you for submitting an ultralytics/notebooks πŸš€ PR! To ensure a seamless integration of your updates to the README, please review the checklist below:

  • βœ… Define a Purpose: Clearly explain the purpose of adding this resource to the README in your PR description. If this addresses an existing issue, consider linking to the related GitHub Issue. Ensure your commit messages are clear and follow the project's conventions.
  • βœ… Synchronize with Source: Confirm your branch is in sync with the main branch of the ultralytics/notebooks repository. If it's behind, please update it by clicking the 'Update branch' button here on GitHub or by running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Verify that all required Continuous Integration (CI) checks are passing. CI checks can ensure the addition is error-freeβ€”please make necessary adjustments if any fail.
  • βœ… Update Documentation: As the PR deals with README updates, ensure the new resources or changes link correctly (as you've added Colab, YouTube, and discussion links). For more guidelines, check the Ultralytics documentation.
  • βœ… Add Tests: For larger changes or code-related updates, tests help confirm functionality. If applicable, include or update tests and make sure they all pass.
  • βœ… Sign the CLA: If this is your first contribution to Ultralytics, please sign the Contributor License Agreement (CLA) by writing "I have read the CLA Document and I sign the CLA" in a new comment.
  • βœ… Minimize Changes: Ensure your PR only contains the necessary changes specific to the README update. This keeps the repository clean and focused. "It is not daily increase but daily decrease, hack away the unessential." β€” Bruce Lee

For additional guidance, review our Contributing Guide. If you encounter any issues or have questions 🧩, feel free to leave a commentβ€”an Ultralytics engineer will assist you soon! Thank you for your contributions to Ultralytics! πŸš€

@RizwanMunawar RizwanMunawar merged commit 715ef66 into main Jan 5, 2025
1 check passed
@UltralyticsAssistant
Copy link
Member

πŸŽ‰ The PR is merged! Huge thanks to @RizwanMunawar for this fantastic contribution! πŸ™Œ

Your work on enhancing the README with a comprehensive tasks section is a true testament to thoughtful collaboration. By simplifying access to resources and unifying the YOLO experience, you've empowered countless users to explore what’s possible with Ultralytics. πŸš€

As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." Your improvements embody this philosophy, making complex tools more approachable for everyone. 🌟

We deeply appreciate your effort and the meaningful impact it will have. Keep shining and innovating! πŸ’ͺ

@RizwanMunawar RizwanMunawar deleted the additional-notebooks-readme branch January 5, 2025 14:04
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants