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

Update README.md #5015

Merged
merged 1 commit into from
Sep 30, 2021
Merged

Update README.md #5015

merged 1 commit into from
Sep 30, 2021

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Sep 30, 2021

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved clarity and consistency of the YOLOv5 README documentation.

πŸ“Š Key Changes

  • Added a note specifying that all checkpoints are trained for 300 epochs using default settings.
  • Clarified metrics terminology with bold formatting (e.g., mAP, Speed, TTA) and modified accompanying descriptions.
  • Removed outdated information regarding Test Time Augmentation (TTA) and autoaugmentation.
  • Provided cleaner, more concise instructions on how to reproduce model accuracy (mAP) and speed benchmarks.

🎯 Purpose & Impact

  • πŸŽ“ Enhanced Understanding: Non-expert users will now find it easier to understand performance metrics and reproduction steps.
  • πŸ” Consistency: By bolding key terms, users can more quickly scan and find important information.
  • 🧹 Updated Information: Removes outdated details, ensuring users are working with the most current data.
  • πŸš€ Ease of Use: Simplified reproduction commands aim to make it straightforward for users to benchmark models on their own systems.

@glenn-jocher glenn-jocher merged commit b20e381 into master Sep 30, 2021
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch September 30, 2021 21:06
BjarneKuehl pushed a commit to fhkiel-mlaip/yolov5 that referenced this pull request Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant