ultralytics / ultralytics

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

Add Export Arguments tables to all Export docs #18952

Closed lakshanthad closed 4 days ago

lakshanthad commented 1 week ago

@glenn-jocher FYI This is a result of the discussions I had with @ambitious-octopus and the ideas from this PR.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced documentation for all model export formats, adding detailed explanations of export arguments to improve user understanding of options.

πŸ“Š Key Changes

🎯 Purpose & Impact

UltralyticsAssistant commented 1 week ago

πŸ‘‹ Hello @lakshanthad, thank you for contributing to the ultralytics/ultralytics πŸš€ repository! We appreciate your efforts to enhance the export documentation. To ensure a seamless review and integration of your PR, please consider the following checklist:

For detailed contribution guidelines, refer to our Contributing Guide.

Notes on Your PR

Your PR introduces an Arguments Table for supported export formats, enhancing documentation clarity. Some suggestions for improvement:

πŸ’‘ If you encounter any challenges or require clarification, feel free to leave a comment. An Ultralytics engineer will review this PR and provide support shortly. Thanks for making Ultralytics better! πŸŽ‰

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 (de06538) to head (7cf439c). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #18952 +/- ## ========================================== + Coverage 73.08% 73.11% +0.03% ========================================== Files 129 129 Lines 17485 17485 ========================================== + Hits 12779 12785 +6 + Misses 4706 4700 -6 ``` | [Flag](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18952/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/18952/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `34.12% <ΓΈ> (+0.03%)` | :arrow_up: | | [GPU](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18952/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `37.94% <ΓΈ> (ΓΈ)` | | | [Tests](https://app.codecov.io/gh/ultralytics/ultralytics/pull/18952/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `66.90% <ΓΈ> (ΓΈ)` | | 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

@lakshanthad @ambitious-octopus guys we've got a disconnect here somewhere. The Export page has detailed comments for each export argument, but the format pages have these very tiny tables lacking details, or even proper punctuation and capitalization. We need consistency here. These tables don't even have the same columns (!), or even the same titles for the existing columns.

https://docs.ultralytics.com/modes/export/#arguments

Export Docs

Screenshot 2025-01-31 at 1 09 50β€―PM

This PR

Screenshot 2025-01-31 at 1 10 35β€―PM
lakshanthad commented 4 days ago

@glenn-jocher Please check the changes. I believe it is good to go. Thanks.

glenn-jocher commented 4 days ago

@lakshanthad great work, looks good now!

UltralyticsAssistant commented 4 days ago

πŸš€βœ¨ Merged and Appreciated! βœ¨πŸš€

Thank you, @lakshanthad, @ambitious-octopus, and @glenn-jocher, for your incredible collaboration on this PR! The enhanced documentation is a game-changer for usability and standardization, paving the way for smoother, more informed deployment workflows. Your attention to detail and dedication to user experience truly shine here. 🌟

As Henry Ford once said, β€œComing together is a beginning, staying together is progress, and working together is success.” This PR embodies that spirit, demonstrating how teamwork can drive innovation and clarity for the entire community. Your efforts will undoubtedly empower countless developers around the world to achieve more, with less guesswork. πŸŒπŸ’‘

Thank you for the passion, precision, and impact you bring to Ultralytics. Onwards and upwards! πŸ™ŒπŸš€