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 #12607

Closed
wants to merge 3 commits into from
Closed

Update README.md #12607

wants to merge 3 commits into from

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 10, 2024

Thank you πŸ™ for your contribution to Ultralytics πŸš€! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.

  3. Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.

  4. Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:

    I have read the CLA Document and I hereby sign the CLA

For more detailed guidance and best practices on contributing, refer to our βœ… Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved documentation and internal API example for YOLOv5.

πŸ“Š Key Changes

  • Updated README files to point to a new blog post and add "alt" text to the YOLO Vision banner images.
  • Refactored README content for the Flask REST API and logger integration guides (ClearML and Comet) for better readability.
  • Streamlined content by removing unnecessary whitespace and consolidating information into fewer paragraphs.

🎯 Purpose & Impact

  • The change in the README banners leads users to a blog post about YOLOv8, helping them stay informed about the latest developments.
  • The updates to the documentation make information about using REST APIs and logger integrations with YOLOv5 more accessible and easier to understand for developers.
  • These updates may enhance user experience by simplifying navigation and comprehension of Ultralytics's tools and resources. πŸ“ˆπŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

glenn-jocher and others added 3 commits January 10, 2024 16:12
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch June 8, 2024 20:16
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

2 participants