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

Add ONNX Docs integrations page #7802

Merged
merged 4 commits into from Jan 25, 2024
Merged

Conversation

abirami-vina
Copy link
Contributor

@abirami-vina abirami-vina commented Jan 24, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced model interoperability and performance through ONNX export support.

πŸ“Š Key Changes

  • Added a new documentation page for exporting Ultralytics models to ONNX format.
  • Updated the Integrations Index to include ONNX as a new method for exporting and optimizing models.
  • Provided a "Key Features of ONNX Models" section to explain benefits like common model representation and graph-based structure.
  • Outlined "Common Usage of ONNX" for CPUs, GPUs, and edge device deployments.
  • Included instructions and example code for exporting YOLOv8 models to ONNX and running inference.

🎯 Purpose & Impact

  • 🎯 To offer a standardized way of model interchange between different AI frameworks, enhancing the YOLOv8 models' flexibility.
  • πŸš€ Users can now deploy Ultralytics models more broadly, including on diverse hardware like CPUs and different platforms like web browsers.
  • πŸ’» Developers gain access to a more streamlined workflow for model conversion, leading to increased efficiency and ease of deployment.
  • 🌍 ONNX Runtime optimizes model performance across platforms, potentially improving the speed and efficiency of Ultralytics models in production environments.

Copy link

codecov bot commented Jan 24, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Comparison is base (a2222b4) 79.11% compared to head (85fdc3e) 39.38%.
Report is 3 commits behind head on main.

❗ Current head 85fdc3e differs from pull request most recent head 81a364f. Consider uploading reports for the commit 81a364f to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #7802       +/-   ##
===========================================
- Coverage   79.11%   39.38%   -39.74%     
===========================================
  Files         117      117               
  Lines       14395    14413       +18     
===========================================
- Hits        11389     5676     -5713     
- Misses       3006     8737     +5731     
Flag Coverage Ξ”
Benchmarks ?
GPU 39.38% <ΓΈ> (-0.05%) ⬇️
Tests ?

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
Copy link
Member

@abirami-vina hey this looks really good! There's just a couple of updates that would really help too when introducing new guides or integrations:

  1. Adding a bullet point about the new guide to guides/index.md or if it's an integration to integrations/index.md. I've done this in c7f1fec.
  2. Adding the new page to the mkdocs.yml file. This file controls what actually gets published, so unless the new file appears here it won't make it to docs.ultralytics.com. Completed in 85fdc3e.

If you could complete these for future PRs that would be super helpful.

Great job on this one!

@glenn-jocher glenn-jocher merged commit c202798 into ultralytics:main Jan 25, 2024
8 checks passed
@abirami-vina
Copy link
Contributor Author

@glenn-jocher Sure, I'll do that from next time.

@glenn-jocher
Copy link
Member

@abirami-vina Fantastic, thank you for the update and for contributing to the project! Looking forward to your next PR. πŸ˜ŠπŸ‘

hmurari pushed a commit to hmurari/ultralytics that referenced this pull request Apr 17, 2024
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.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.

None yet

2 participants