Skip to content

Fix YOLOE prompt-free validation example in docs#21745

Merged
Laughing-q merged 4 commits intoultralytics:mainfrom
ShuaiLYU:improve-yoloe-doc
Aug 20, 2025
Merged

Fix YOLOE prompt-free validation example in docs#21745
Laughing-q merged 4 commits intoultralytics:mainfrom
ShuaiLYU:improve-yoloe-doc

Conversation

@ShuaiLYU
Copy link
Copy Markdown
Contributor

@ShuaiLYU ShuaiLYU commented Aug 20, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Docs and minor code tweaks for YOLOE: correct model checkpoints, clearer validation example, and quieter device selection logging. ✅

📊 Key Changes

  • Updated docs to use the correct YOLOE segmentation weights: yoloe-11l-seg-pf.pt (and yoloe-11s/m-seg-pf.pt). 📚
  • Validation example now includes single_cls=True for class-agnostic evaluation in the snippet. 🧪
  • Suppressed device selection logs in YOLOE validation by calling select_device(..., verbose=False). 🤫

🎯 Purpose & Impact

  • Ensures users load the right pretrained weights, reducing confusion and errors. 🔒
  • Provides a more accurate, ready-to-run validation example for common setups. 🚀
  • Produces cleaner console/CI output during validation runs, improving usability and readability. 🧹

See the Ultralytics Docs for details.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 20, 2025

All Contributors have signed the CLA. ✅
Posted by the CLA Assistant Lite bot.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation segment Instance Segmentation issues, PR's labels Aug 20, 2025
@UltralyticsAssistant
Copy link
Copy Markdown
Member

👋 Hello @ShuaiLYU, thank you for submitting an ultralytics/ultralytics 🚀 PR! This is an automated response — an Ultralytics engineer will review and assist you soon. In the meantime, 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

Notes for this PR:

  • Thanks for updating docs/en/models/yoloe.md to refresh the YOLOE validation example and checkpoint names 🙌
  • Please confirm the updated example weights (e.g., yoloe-11l-seg-pf.pt and s/m variants) are available and load correctly, and that the validation snippet with single_cls=True behaves as intended for segmentation tasks.
  • If you haven’t already, ensure the docs build passes locally and examples are copy-paste runnable ✅

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! 🚀

@ShuaiLYU ShuaiLYU changed the title Import YOLOE doc Improve YOLOE doc Aug 20, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Aug 20, 2025

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
ultralytics/models/yolo/yoloe/val.py 0.00% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@Laughing-q Laughing-q changed the title Improve YOLOE doc Fix YOLOE prompt-free validation example in docs Aug 20, 2025
@Laughing-q Laughing-q merged commit ebb447c into ultralytics:main Aug 20, 2025
16 checks passed
@UltralyticsAssistant
Copy link
Copy Markdown
Member

Huge thanks and congratulations on the merge, @ShuaiLYU — and kudos to @Laughing-q for the teamwork! As Leonardo da Vinci said, “Simplicity is the ultimate sophistication,” and this PR embodies that: correct YOLOE segmentation checkpoints (yoloe-11l-seg-pf.pt and yoloe-11s/m-seg-pf.pt), a clearer validation example with single_cls=True, and quieter device selection for cleaner logs. These refinements reduce confusion, improve usability in CI, and help users get reliable results faster. Appreciate the precision and polish you brought here. See the Ultralytics Docs for details.

yyq19990828 pushed a commit to yyq19990828/ultralytics_dev that referenced this pull request Aug 22, 2025
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 segment Instance Segmentation issues, PR's

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants