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

Improve classification comments #8997

Merged
merged 1 commit into from
Aug 17, 2022
Merged

Improve classification comments #8997

merged 1 commit into from
Aug 17, 2022

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Aug 17, 2022

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancement of documentation and examples for the Ultralytics YOLOv5 classification models.

πŸ“Š Key Changes

  • Updated training checkpoint details, now including weight_decay parameter.
  • Transitioned from showcasing the validation of the YOLOv5s-cls model to the YOLOv5m-cls model on the ImageNet-1k dataset.
  • Predict section now suggests using the pretrained YOLOv5s-cls model to predict a single image (bus.jpg).
  • Clarified the Export section by specifying the export of YOLOv5s-cls, ResNet, and EfficientNet models.
  • Various documentation updates across the classify sub-module for clarity and consistency in instructions.

🎯 Purpose & Impact

  • The added weight_decay parameter in documentation helps users understand model training configurations better.
  • Highlighting the YOLOv5m-cls model provides insights into using a different category of pre-trained weights, possibly indicating a more robust or accurate model.
  • Clarified examples make it easier for users to follow how to run individual tasks such as validating, predicting, and exporting models.
  • The changes can lead to better user adoption and efficient usage of the YOLOv5 classification models, spreading knowledge on how to engage with the classification aspect of the Ultralytics ecosystem. πŸš€

@glenn-jocher glenn-jocher self-assigned this Aug 17, 2022
@glenn-jocher glenn-jocher merged commit e617569 into master Aug 17, 2022
@glenn-jocher glenn-jocher deleted the update/cls_docs branch August 17, 2022 13:33
ctjanuhowski pushed a commit to ctjanuhowski/yolov5 that referenced this pull request Sep 8, 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