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

Documentation fixes and improvements #19749

Merged
merged 50 commits into from
Mar 17, 2025
Merged

Documentation fixes and improvements #19749

merged 50 commits into from
Mar 17, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Mar 17, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

WARNING ⚠️ this PR is very large, summary may not cover all changes.

🌟 Summary

This PR enhances dataset documentation for classification, detection, segmentation, and pose estimation tasks, improving clarity, consistency, and usability for users.

📊 Key Changes

  • Classification Datasets: Updated descriptions for datasets like Caltech-101, CIFAR-10, and ImageNet, adding links to relevant terms and improving clarity on usage.
  • Detection Datasets: Enhanced details for datasets like COCO, SKU-110K, and VisDrone, including applications and YAML configuration examples.
  • Segmentation Datasets: Improved documentation for datasets like COCO-Seg and Crack-Seg, emphasizing real-world applications and benefits of YOLO models.
  • Pose Estimation Datasets: Expanded descriptions for datasets like Dog-Pose and Hand Keypoints, highlighting key features and use cases.
  • General Improvements: Added links to related resources, clarified dataset structures, and provided examples for training and inference.

🎯 Purpose & Impact

  • Improved Usability: Clearer instructions and examples make it easier for users to train models on various datasets.
  • Enhanced Accessibility: Added links to related terms and resources for a more seamless learning experience.
  • Broader Applications: Highlighted real-world use cases, encouraging adoption in diverse industries like healthcare, agriculture, and automotive. 🚗🌾

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Mar 17, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/ultralytics 🚀 PR! This is an automated response to help streamline the review process. An Ultralytics engineer will review your PR shortly. In the meantime, please review the following checklist to ensure your PR meets the project requirements:

  • Define a Purpose: Ensure the purpose of your PR is clearly stated in the description, and link to any relevant issues if applicable. Clear commit messages are highly encouraged!
  • Synchronize with Source: Ensure your PR is up to date with the main branch of ultralytics/ultralytics. If it's behind, please update it by clicking 'Update branch' or running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify that all Continuous Integration (CI) checks pass. Address any issues if checks fail.
  • Update Documentation: If your PR modifies functionality or adds new features, ensure you update the relevant documentation.
  • Add Tests: Include or update tests to ensure your changes are thoroughly validated, and confirm all tests pass.
  • Sign the CLA: If this is your first contribution, please sign the Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA".
  • Minimize Changes: Ensure your changes are focused and concise, addressing only the purpose of the PR. As Bruce Lee said, "It is not daily increase but daily decrease, hack away the unessential."

For more information, please refer to our Contributing Guide. If you have any specific questions, feel free to leave a comment here, and we'll assist you as soon as possible. 🚀

Your documentation refactor looks excellent so far! The enhancements to dataset clarity, updated links, and expanded FAQs will undoubtedly improve user experience and usability. Keep up the great work! 🌟

UltralyticsAssistant and others added 3 commits March 17, 2025 19:16
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.85%. Comparing base (ef208f3) to head (9e4060e).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19749      +/-   ##
==========================================
- Coverage   72.86%   72.85%   -0.02%     
==========================================
  Files         133      133              
  Lines       17735    17735              
==========================================
- Hits        12922    12920       -2     
- Misses       4813     4815       +2     
Flag Coverage Δ
Benchmarks 33.75% <ø> (ø)
GPU 37.50% <ø> (ø)
Tests 66.73% <ø> (-0.02%) ⬇️

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.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

glenn-jocher and others added 20 commits March 17, 2025 20:21
# Conflicts:
#	docs/en/macros/predict-args.md
@glenn-jocher glenn-jocher changed the title Documentation refactor Documentation fixes and improvements Mar 17, 2025
@glenn-jocher glenn-jocher merged commit acd38cb into main Mar 17, 2025
19 checks passed
@glenn-jocher glenn-jocher deleted the update-docs branch March 17, 2025 20:52
@UltralyticsAssistant
Copy link
Member

"🎉 Amazing work, @glenn-jocher! This comprehensive PR takes our dataset documentation to the next level, making it more accessible and impactful for the community. As Leonardo da Vinci once said, “Simplicity is the ultimate sophistication.” Your dedication to clarity and usability embodies this perfectly, empowering users to harness the full potential of YOLO models across diverse applications. Thank you for your incredible contributions and vision! 🚀🙌"

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants