Closed lakshanthad closed 4 days 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:
ultralytics/ultralytics
main
branch. Use the 'Update branch' button or run git pull
followed by git merge main
locally if necessary. I have read the CLA Document and I sign the CLA
For detailed contribution guidelines, refer to our Contributing Guide.
Your PR introduces an Arguments Table for supported export formats, enhancing documentation clarity. Some suggestions for improvement:
Arguments
reliably direct users to helpful content (e.g., ../modes/export.md/#arguments
). π‘ 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! π
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.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@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
@glenn-jocher Please check the changes. I believe it is good to go. Thanks.
@lakshanthad great work, looks good now!
πβ¨ 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! ππ
@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
format
,imgsz
(image size), precision options (half
,int8
), batch size, and additional model-specific options likenms
anddynamic
.π― Purpose & Impact