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 datasets.py comments #5088

Merged
merged 1 commit into from
Oct 7, 2021
Merged

Update datasets.py comments #5088

merged 1 commit into from
Oct 7, 2021

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Oct 7, 2021

Improved comments for dataloaders.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced data loader docstrings for improved clarity and functionality explanation.

πŸ“Š Key Changes

  • Updated comments to provide clear explanations of the data loaders' purposes right within their class definitions.
  • LoadImages, LoadWebcam, and LoadStreams classes have added explanatory comments describing their use cases.
  • LoadImagesAndLabels class now includes a comment indicating its use in training and validation.
  • Enhanced comments for load_mosaic and load_mosaic9 methods to clarify that they load images into 4-image and 9-image mosaics, respectively.

🎯 Purpose & Impact

  • πŸ“ Better Documentation: The new comments serve to guide users more clearly on how to use the different data loaders for images, videos, webcams, streams, and during training/validation.
  • πŸ’‘ Improved Understanding: With these comments, users, especially new ones, can better understand the purpose of each class and function at a glance, potentially speeding up their development process.
  • ✨ Enhanced Usability: As users get more information directly from the source code, these changes can improve the usability of the YOLOv5 library, making it more user-friendly.

@glenn-jocher glenn-jocher merged commit 57ce73c into master Oct 7, 2021
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch October 7, 2021 23:04
@glenn-jocher glenn-jocher self-assigned this Oct 7, 2021
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