ultralytics / ultralytics

Ultralytics YOLO11 πŸš€
https://docs.ultralytics.com
GNU Affero General Public License v3.0
36.33k stars 7k forks source link

Enhance clarity in `results.to_` function examples. #18957

Closed RizwanMunawar closed 1 week ago

RizwanMunawar commented 1 week ago

@glenn-jocher

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved code examples in the results.py module for consistent indentation and clarity across result usage workflows.

πŸ“Š Key Changes

🎯 Purpose & Impact

🀝 Overall, this update streamlines the user experience and fosters better understanding of the API examples.

UltralyticsAssistant commented 1 week ago

πŸ‘‹ Hello @RizwanMunawar, thank you for opening this ultralytics/ultralytics πŸš€ pull request! This is an automated response to assist you in ensuring a smooth contribution process. An Ultralytics engineer will review your PR soon. In the meantime, please review the following checklist to streamline integration:

Additional Suggestions πŸ’‘

For more detailed contribution guidance, see our Contributing Guide.

Thank you for helping improve Ultralytics! πŸš€ If you have any questions, don't hesitate to leave a comment. 😊

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 73.11%. Comparing base (46d155a) to head (2908dd9). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #18957 +/- ## ========================================== - Coverage 73.12% 73.11% -0.01% ========================================== Files 129 129 Lines 17486 17486 ========================================== - Hits 12786 12785 -1 - Misses 4700 4701 +1 ``` | [Flag](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18957/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | Coverage Ξ” | | |---|---|---| | [Benchmarks](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18957/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `34.12% <ΓΈ> (ΓΈ)` | | | [GPU](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18957/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `37.95% <ΓΈ> (ΓΈ)` | | | [Tests](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18957/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `66.90% <ΓΈ> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

glenn-jocher commented 1 week ago

@RizwanMunawar good improvments! I'm a little unclear on the continuation line syntax but I think we need to use ... on both lines in the for loop or just keep using >>> for all the lines?

RizwanMunawar commented 1 week ago

@glenn-jocher ok let's continue with >>> for all lines!

UltralyticsAssistant commented 1 week ago

πŸŽ‰ Amazing work, @RizwanMunawar and @glenn-jocher! Your contributions to this PR truly embody the spirit of collaboration and excellence. ✨

As Albert Einstein once said, "Strive not to be a success, but rather to be of value." This update adds immense value by improving clarity and accessibility for our communityβ€”helping developers, both new and experienced, navigate the results.py module with ease.

Thank you for your attention to detail and dedication to enhancing the Ultralytics experience. πŸš€ Your efforts make a lasting impact, and we're truly grateful! πŸ™Œ