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 type for train arguments #18221

Merged
merged 7 commits into from
Dec 15, 2024
Merged

Add type for train arguments #18221

merged 7 commits into from
Dec 15, 2024

Conversation

RizwanMunawar
Copy link
Member

@RizwanMunawar RizwanMunawar commented Dec 13, 2024

@glenn-jocher Hi, this PR adds type annotations for each train argument. We already have the types for the predict, export, and track arguments, but train was missing until now. Thank you!

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Documentation updates improve clarity and accuracy across object counting, region counting, and argument descriptions in Ultralytics YOLO guides.

πŸ“Š Key Changes

  • πŸ”§ Renamed Object Counter to ObjectCounter and Region Counter to RegionCounter for consistency in code examples within object and region counting guides.
  • πŸ“ Enhanced table formats in predict-args.md and train-args.md:
    • Added explicit data types to columns for argument definitions.
    • Improved alignment and readability of default values and descriptions.

🎯 Purpose & Impact

  • 🎯 Clarity: Improved terminology consistency in the guides ensures easier understanding and usage for users following the documentation.
  • πŸ“– Readability: Enhanced formatting in argument descriptions aids quick reference and comprehension for developers configuring models.
  • πŸ› οΈ Developer Usability: Streamlined examples and clear naming reduce potential errors when implementing code snippets from the guides.

These changes make Ultralytics documentation more user-friendly and precise, benefiting both beginners and advanced users. πŸš€

@RizwanMunawar RizwanMunawar self-assigned this Dec 13, 2024
@RizwanMunawar RizwanMunawar added documentation Improvements or additions to documentation enhancement New feature or request detect Object Detection issues, PR's labels Dec 13, 2024
@UltralyticsAssistant
Copy link
Member

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

  • βœ… Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • βœ… Synchronize with Source: Confirm your PR is synchronized with the ultralytics/ultralytics main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • βœ… Update Documentation: Update the relevant documentation for any new or modified features.
  • βœ… Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • βœ… Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • βœ… Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." β€” Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! πŸš€

This is an automated response, but rest assured, an Ultralytics engineer will review your request soon. 😊

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 73.97%. Comparing base (0fb6788) to head (986ed5c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18221      +/-   ##
==========================================
- Coverage   73.97%   73.97%   -0.01%     
==========================================
  Files         128      128              
  Lines       17138    17138              
==========================================
- Hits        12678    12677       -1     
- Misses       4460     4461       +1     
Flag Coverage Ξ”
Benchmarks 35.00% <ΓΈ> (ΓΈ)
GPU 38.47% <ΓΈ> (ΓΈ)
Tests 67.76% <ΓΈ> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@glenn-jocher
Copy link
Member

@RizwanMunawar great improvement! Can you check the other main tables and add missing types to those also if applicable?

@glenn-jocher glenn-jocher merged commit b645083 into main Dec 15, 2024
16 checks passed
@glenn-jocher glenn-jocher deleted the improve-docs branch December 15, 2024 17:44
Y-T-G pushed a commit to namas191297/ultralytics that referenced this pull request Dec 17, 2024
Co-authored-by: UltralyticsAssistant <[email protected]>
Co-authored-by: Glenn Jocher <[email protected]>
@RizwanMunawar RizwanMunawar removed their assignment Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
detect Object Detection issues, PR's documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants