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

OBB Docs updates #7512

Merged
merged 12 commits into from
Jan 11, 2024
Merged

OBB Docs updates #7512

merged 12 commits into from
Jan 11, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 11, 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

Update linkage, remove deprecated hook, enhance AI model results

📊 Key Changes

  • ➖ Removed the PyCQA docformatter hook from the pre-commit configuration.
  • 🔄 Updated README links for ClearML from shortened URLs to the direct https://clear.ml/ link.
  • 🌐 Improved language support in Chinese README.
  • 🛠 Fixed various typos and improved formatting in documentation files.
  • ✨ Added support for returning oriented bounding box (OBB) results in AI model predictions.

🎯 Purpose & Impact

  • 🧹 The cleanup in the pre-commit config may reduce overhead and potential for conflicts with other formatting tools.
  • 📝 The link updates ensure users are guided directly to the referenced services with no redirection.
  • 🌍 Language corrections in documentation improve understanding for non-English speakers.
  • 🐛 Typo fixes and formatting improvements increase the professionalism and readability of the documentation, benefiting all users.
  • 🚀 By adding OBB results support, Ultralytics' AI models become more versatile in handling complex object detection scenarios, greatly benefiting projects requiring precise geometric annotations, such as aerial and satellite imagery analysis.

glenn-jocher and others added 3 commits January 11, 2024 21:24
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (09ee982) 79.13% compared to head (61beccd) 77.06%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7512      +/-   ##
==========================================
- Coverage   79.13%   77.06%   -2.08%     
==========================================
  Files         117      117              
  Lines       14331    14331              
==========================================
- Hits        11341    11044     -297     
- Misses       2990     3287     +297     
Flag Coverage Δ
Benchmarks 35.55% <0.00%> (ø)
GPU 39.59% <0.00%> (ø)
Tests 72.37% <100.00%> (-2.62%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@glenn-jocher glenn-jocher changed the title Docs updates OBB Docs updates Jan 11, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit 4dc8c40 into main Jan 11, 2024
11 checks passed
@glenn-jocher glenn-jocher deleted the docs branch January 11, 2024 23:06
gkinman pushed a commit to Octasic/ultralytics that referenced this pull request May 30, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Muhammad Rizwan Munawar <chr043416@gmail.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
puzhiyuan pushed a commit to puzhiyuan/ultralytics that referenced this pull request Oct 18, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Muhammad Rizwan Munawar <chr043416@gmail.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
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.

3 participants