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 KaTeX support + updates to YOLOv9 model page #8531

Merged
merged 9 commits into from
Mar 2, 2024

Conversation

Burhan-Q
Copy link
Member

@Burhan-Q Burhan-Q commented Feb 28, 2024

  • Adds KaTeX support for fast rendering of formula and mathematical symbols

  • Update formula on YOLOv9 to render using KaTeX (see screenshots)

    Dark mode rendered equations

    image

    Light mode rendered equations

    image

    Current non-rendered equations

    image

  • Changed YOLOv9 performance table to use same headers from other docs pages and drop extraneous columns for S/M/L benchmarks (not included anywhere else in docs)

    • Table also updated with image sizes shown in GitHub repo (not found in paper)

    Reformat YOLOv9 table

    image

    YOLOv8 table to compare

    image

    Current YOLOv9 table

    image

  • Include link to YOLOv8 page on YOLOv8 text, removed hyphen between v8 and X, and made lower-cased x for consistency with YOLOv8 docs

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancement of YOLOv9 documentation with better mathematical notation and KaTeX math rendering support.

πŸ“Š Key Changes

  • Replaced Python code snippets with clearer LaTeX-like mathematical formulas in the YOLOv9 documentation.
  • Added a new JavaScript file (katex.js) to enable rendering of LaTeX-like math directly on the webpage.
  • Updated mkdocs.yml to include KaTeX CSS and JavaScript URLs for math rendering, and added the arithmatex extension to support this feature.

🎯 Purpose & Impact

  • Improved Readability: The use of LaTeX-like syntax ($$...$$) for math in docs makes the content more reader-friendly for those familiar with mathematical notation.
  • Enhanced Documentation Quality: The addition of KaTeX will display mathematical expressions more accurately and professionally in the browser, providing a better user experience.
  • Broader Audience Engagement: With clearer representation of complex concepts, YOLOv9 can now engage a more diverse audience, including academia and research sectors, potentially increasing its adoption.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced YOLOv9 documentation with updated performance tables and clearer model comparisons.

πŸ“Š Key Changes

  • πŸ“ Restructured YOLOv9 performance table for better readability.
  • πŸ–‹οΈ Added model input size to the performance table.
  • πŸ”„ Changed the order of columns, leading with model size and AP metrics for clarity.
  • πŸ”— Linked YOLOv8-X to its respective documentation for easy reference.

🎯 Purpose & Impact

  • πŸ“– Makes it easier for users to understand model performance at a glance.
  • πŸ€– Helps in selecting the appropriate YOLOv9 model variant based on accuracy and computational requirements.
  • πŸš€ Enhances accessibility to model details, potentially driving more informed decisions regarding model use in applications.

@Burhan-Q Burhan-Q added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 28, 2024
Copy link

codecov bot commented Feb 29, 2024

Codecov Report

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

Project coverage is 38.99%. Comparing base (2100d28) to head (5c8623d).
Report is 1 commits behind head on main.

❗ Current head 5c8623d differs from pull request most recent head bb27177. Consider uploading reports for the commit bb27177 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #8531       +/-   ##
===========================================
- Coverage   75.57%   38.99%   -36.59%     
===========================================
  Files         117      117               
  Lines       14695    14695               
===========================================
- Hits        11106     5730     -5376     
- Misses       3589     8965     +5376     
Flag Coverage Ξ”
Benchmarks ?
GPU 38.99% <ΓΈ> (-0.02%) ⬇️
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

@Burhan-Q oh hey thanks! I was struggling with the latex equations originally and finally gave up and switched to python code instead. I'm not sure what's better now since the new updates aren't as readable in Markdown if viewed from an IDE or a on our github page. What do you think?

New table 100% looks great, can you submit a separate PR just for that?

@glenn-jocher
Copy link
Member

glenn-jocher commented Mar 1, 2024

@Burhan-Q BTW the original with latex looked like this:

### Information Bottleneck Principle

The Information Bottleneck Principle reveals a fundamental challenge in deep learning: as data passes through successive layers of a network, the potential for information loss increases. This phenomenon is mathematically represented as:

\[I(X, X) \geq I(X, f_{\theta}(X)) \geq I(X, g_{\phi}(f_{\theta}(X))),\]

where \(I\) denotes mutual information, and \(f\) and \(g\) represent transformation functions with parameters \(\theta\) and \(\phi\), respectively. YOLOv9 counters this challenge by implementing Programmable Gradient Information (PGI), which aids in preserving essential data across the network's depth, ensuring more reliable gradient generation and, consequently, better model convergence and performance.

### Reversible Functions

The concept of Reversible Functions is another cornerstone of YOLOv9's design. A function is deemed reversible if it can be inverted without any loss of information, as expressed by:

\[X = v_{\zeta}(r_{\psi}(X)),\]

with \(\psi\) and \(\zeta\) as parameters for the reversible and its inverse function, respectively. This property is crucial for deep learning architectures, as it allows the network to retain a complete information flow, thereby enabling more accurate updates to the model's parameters. YOLOv9 incorporates reversible functions within its architecture to mitigate the risk of information degradation, especially in deeper layers, ensuring the preservation of critical data for object detection tasks.

@Laughing-q
Copy link
Member

@Burhan-Q @glenn-jocher For IDE I think there should be some tools or plugins can preview these formulas, but yes it's not readable on github page for users(actually it can be, with some sort of browser plugin, but can't assume that every user has that).

@glenn-jocher
Copy link
Member

@Burhan-Q yeah maybe we should leave the code as is, especially considering we'd need to load additional javascript for all the pages just for the equations here on this one page.

In GitHub the individual letters render correctly but not the equation enclosed with $$

Screenshot 2024-03-01 at 11 19 27

@Burhan-Q
Copy link
Member Author

Burhan-Q commented Mar 1, 2024

@glenn-jocher understood. I wanted to try the native KaTeX first because it will render nicely on the site but I do understand that it's also beneficial to have it render prettier in the markdown file too. Already have a backup plan to insert images for the equations and there are Unicode versions of the Greek letters that should work ψ,Β ΞΈ, Ο•, 𝜁 for the inline text. I'll update the PR to use these.

Do you still want me to split off the table update to a new PR as well?

glenn-jocher and others added 3 commits March 1, 2024 12:30
…y background (viewable light or dark themes), inline italics for letter variables, and inline unicode Greek letters.
@Burhan-Q
Copy link
Member Author

Burhan-Q commented Mar 1, 2024

yolov9_001-2
yolov9_002-2

@Burhan-Q
Copy link
Member Author

Burhan-Q commented Mar 1, 2024

@glenn-jocher updated with images and inline Unicode, removed KaTeX plugin from config and extra .js file

@Burhan-Q
Copy link
Member Author

Burhan-Q commented Mar 1, 2024

image

@glenn-jocher
Copy link
Member

glenn-jocher commented Mar 2, 2024

@Burhan-Q hey thanks for your effort here. I think there's no simple solution since each has it's drawbacks. Maybe if we start to incorporate more equations throughout the docs we should add the latex CSS support, but for now I think let's keep it simple and leave the python code in place (since we have a lot of that already present).

One interesting thing I thought is that I found you could replace the greek words with their symbols and they do seem to render correctly the Python code block, though it looks kind of funny since I've never actually seen python code with the symbols.

@glenn-jocher glenn-jocher merged commit 28a9d41 into ultralytics:main Mar 2, 2024
2 checks passed
@glenn-jocher
Copy link
Member

@Burhan-Q PR merged!

DannyCooler added a commit to ecs-enerserv/ultralytics that referenced this pull request Mar 28, 2024
* Explorer API video https://youtu.be/3VryynorQeo  (ultralytics#7838)

* Add HUB-SDK Docs reference section (ultralytics#7781)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com>

* Link checks SSL insecure robustness (ultralytics#7853)

* Add new @Retry() decorator (ultralytics#7854)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add TensorRT Docs Integrations Page (ultralytics#7855)

* Cleanup Docs languages (ultralytics#7865)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add millimeters in `solutions/distance_caculation.py` + `object-cropping.md` visuals (ultralytics#7860)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.7` `USER_CONFIG_DIR` Explorer ops (ultralytics#7861)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Ultralytics Actions with OpenAI GPT-4 PR Summary (ultralytics#7867)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Bump slackapi/slack-github-action from 1.24.0 to 1.25.0 in /.github/workflows (ultralytics#7871)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add visuals in `guides/distance-calculation.md` (ultralytics#7876)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* TensorRT FP16 export with `dynamic=True` (ultralytics#7870)

* Add https://youtu.be/3VryynorQeo to README and fix `converter.py` Docs (ultralytics#7883)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* `ultralytics 8.1.8` new `model.save('filename.pt')` method (ultralytics#7886)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Compress explorer image in `dataset/index.md` + description added for new `segmentation` datasets (ultralytics#7901)

* Fix OpenVINO links (ultralytics#7930)

* Add `integrations/gradio` Docs page (ultralytics#7935)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: WangQvQ <1579093407@qq.com>
Co-authored-by: Martin Pl <martin-plank@gmx.de>
Co-authored-by: Mactarvish <Mactarvish@users.noreply.github.com>

* Add https://youtu.be/96NkhsV-W1U to docs and `heatmaps` fix (ultralytics#7944)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Segment TensorRT `batch=3` fix (ultralytics#7952)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.9` replace `.size(0)` with `.shape[0]` (ultralytics#7957)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add YouTube iframe `loading="lazy"` (ultralytics#8001)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Mkdocs updates (ultralytics#8008)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Tracker: clean up GMC (ultralytics#8003)

* Bump nick-invision/retry from 2 to 3 in /.github/workflows (ultralytics#8023)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump codecov/codecov-action from 3 to 4 in /.github/workflows (ultralytics#8022)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Fix TFLite INT8 for OBB (ultralytics#7989)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add CoreML Docs Integrations Page (ultralytics#8063)

* Add Roboflow 100 Dataset Docs Page (ultralytics#8065)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.10` MLFlow, OBB, TFLite and INT8 fixes (ultralytics#8016)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add https://youtu.be/R42s2zFtNIY to `hub/datasets.md` and CoreML image fix (ultralytics#8085)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update Roboflow segmentation Docs pages (ultralytics#8094)

* FROM pytorch/pytorch:2.2.0-cuda12.1-cudnn8-runtime (ultralytics#8104)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.11` expand OpenVINO INT8 ops for improved mAP (ultralytics#7516)

Co-authored-by: AdamP <7806910+adamp87@users.noreply.github.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Add https://youtu.be/q7LwPoM7tSQ to `guides/yolo-performance-metrics.md` (ultralytics#8114)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Compress docs images (ultralytics#8124)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Updated SQL Query Plot Code (ultralytics#8120)

Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Elaborate Train and Predict mode docs arguments (ultralytics#8137)

Signed-off-by: Skillnoob <78843978+Skillnoob@users.noreply.github.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Skillnoob <78843978+Skillnoob@users.noreply.github.com>
Co-authored-by: Burhan <62214284+Burhan-Q@users.noreply.github.com>

* Move Google Drive to slow tests (ultralytics#8163)

* Improve Coral Edge TPU guide (ultralytics#8160)

Signed-off-by: Skillnoob <78843978+Skillnoob@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Try Apple M1 runners for Tests and Benchmarks CI (ultralytics#8162)

* Retry once for Docker CI failures (ultralytics#8164)

* `ultralytics 8.1.12` new `Results.show()` and `Results.save()` (ultralytics#8166)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Fix solution functions description + `integrations/openvino.md` cover image update (ultralytics#8170)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Pin `duckdb<=0.9.2` to avoid 0.10.0 errors (ultralytics#8181)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* New HUB Cloud Training docs page (ultralytics#8174)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.13` fix `yolo train time=` bug (ultralytics#8179)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Docs updates and improvements (ultralytics#8183)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Priytosh Tripathi <priytosh.revolution@live.com>

* Fix xyxyxyxyn calculation in obb result (ultralytics#8188)

* `ultralytics 8.1.14` new YOLOv8-World models (ultralytics#8054)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix PIL `show()` and `save()` (ultralytics#8202)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Remove OpenVINO INT8 RTDETRDecoder ops (ultralytics#8219)

* Fix xyxyxyxyn calculation, swap axis (ultralytics#8249)

* Improve Docs Modes tables (ultralytics#8266)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.15` add Python 3.12 compatibility (ultralytics#8210)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Johnny <johnnynuca14@gmail.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Expand `Model` method type hinting (ultralytics#8279)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.16` OBB ConfusionMatrix support (ultralytics#8299)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Move Explorer tests to scheduled CI (ultralytics#8305)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Remove JAX constraints in Exporter (ultralytics#8309)

* `Model` typehints Docker fix (ultralytics#8306)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix an issue with flatbuffer version for Raspberry Pi (ultralytics#8311)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update Dockerfile for Raspberry Pi Support (ultralytics#8123)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Avoid creating `-hub` dir without processing images (ultralytics#8334)

* Added check of parameter type before setting `required_grad=True` for frozen layers (ultralytics#8318)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add `estimate_speed(region_color)` parameter (ultralytics#8285)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add simple-utilities.md Docs page (ultralytics#8269)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update `mkdocs-ultralytics-plugin>=0.0.44` (ultralytics#8347)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.17` fix `ClassificationDataset` caching (ultralytics#8358)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add missing single-line docstrings (ultralytics#8362)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Johannes Kaisinger <johannes.kaisinger@gmail.com>

* `ultralytics 8.1.18` add cmake for building onnxsim on aarch64 (ultralytics#8395)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Allow Annotator PIL.Image inputs (ultralytics#8397)

* Add Non-Maximum Suppression (NMS) `inplace` flag (ultralytics#8368)

* Compare `plt.get_backend()` in lowercase (ultralytics#8409)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Improve Docs arguments tables (ultralytics#8415)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add plot_images `conf_thresh` parameter (ultralytics#8446)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add YOLOv9 Docs page (ultralytics#8478)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Rename `model_id` to `model.id` (ultralytics#8447)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.19` PNNX `aarch64` linux fix (ultralytics#8480)

Co-authored-by: Burhan <62214284+Burhan-Q@users.noreply.github.com>
Co-authored-by: Kayzwer <68285002+Kayzwer@users.noreply.github.com>

* Add TorchScript Docs Integrations Page (ultralytics#8501)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Do RTDETR file suffix check using pathlib instead of string manipulations (ultralytics#8525)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Auto-format by https://ultralytics.com/actions

* Add TFLite Docs Integrations Page (ultralytics#8522)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix undefined β€˜im_array’ bug in predict.md (ultralytics#8565)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: fang_chenfang <1217690899@qq.com>

* Add https://youtu.be/ie3vLUDNYZo and other YT videos in Docs (ultralytics#8551)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Hold failed upload metrics and upload with next upload metrics (ultralytics#8513)

Co-authored-by: hassaanfarooq01 <hassaanfarooq01@gmail.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.20` add YOLOv8x-World support (ultralytics#8539)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix device counting method to account for double-digit device IDs (ultralytics#8502)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Remove unused variables (ultralytics#8511)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add NCNN Docs Integrations Page (ultralytics#8562)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Optimize function calls to method calls (ultralytics#8507)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Replacing Images for torchscript.md (ultralytics#8596)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix cmake requirements for ARM64 (ultralytics#8589)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add https://youtu.be/rCggzXRRSRo to Speed Estimation Docs (ultralytics#8577)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add KaTeX support + updates to YOLOv9 model page (ultralytics#8531)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Replace `onnx2tf` usage from CLI to Python (ultralytics#8429)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update IoU capitalization (ultralytics#8604)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Dean Mark <2552482+deanmark@users.noreply.github.com>

* Update TFLite Docs images (ultralytics#8605)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add `distance calculation` feature in `vision-eye` (ultralytics#8616)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Muhammad Rizwan Munawar <chr043416@gmail.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* `ultralytics 8.1.21` Add YOLOv8-World-v2 models (ultralytics#8580)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* `ultralytics 8.1.22` HUB model `pathlib` fix (ultralytics#8621)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.23` add YOLOv9-C and E models (ultralytics#8571)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add settings `runs_dir` == `datasets_dir` warning (ultralytics#8653)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add Ultralytics HUB Cloud Training banner to Docs (ultralytics#8656)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update CITATION.cff with cffinit corrections (ultralytics#8658)

* Update Colab notebook for YOLOv8.1 (ultralytics#8660)

* `ultralytics 8.1.24` new OpenVINO 2023.3 export updates (ultralytics#8417)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* OBB: Fix when training on zip data (ultralytics#8680)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Object Counter improvements (ultralytics#8648)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Clarify triton server boolean value (ultralytics#8532)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add `model.eval()` in TensorBoad graph visualization to avoid BN stats changes (ultralytics#8629)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add domain checks to CI docs page (ultralytics#8714)

* `ultralytics 8.1.25` OpenVINO `LATENCY` and `THROUGHPUT` modes (ultralytics#8058)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Adrian Boguszewski <adekboguszewski@gmail.com>

* Add https://youtu.be/OpWpBI35A5Y to inference-api Docs (ultralytics#8717)

* OpenVino 2024.0.0 (ultralytics#8726)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix tfjs exports for ARM64 Dockerfile (ultralytics#8766)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Modify tuner best.pt logic to train first (ultralytics#8792)

* Update CI.md with CI links (ultralytics#8786)

* Add https://youtu.be/ZzUSXQkLbNw to Integration Docs (ultralytics#8793)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.25` fix `**kwargs: (dict)` warnings (ultralytics#8815)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add docs guide terminal images (ultralytics#8819)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `RTDETRDetectionModel` TorchScript, ONNX Predict and Val support (ultralytics#8818)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* New `MLFLOW_KEEP_RUN_ACTIVE` flag for enhanced MLflow run management (ultralytics#8808)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.26` `LoadImagesAndVideos` batched inference (ultralytics#8817)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update `fraction` arg to employ a random selection (ultralytics#8234)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Batch inference fixes (ultralytics#8854)

* Integrate OpenVINO `CUMULATIVE_THROUGHPUT` mode batched inference (ultralytics#8834)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add PaddlePaddle Docs Integrations Page (ultralytics#8858)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.27` batched tracking fixes (ultralytics#8842)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Faster batch `same_shapes` (ultralytics#8851)

* More robust PNNX downloads (ultralytics#8866)

* Fix `test_mlflow_keep_run_active()` (ultralytics#8868)

* Add polygon regions drawing support in `object-counting.md` and minor docs update (ultralytics#8885)

* Add TFLite Edge TPU Docs Integrations Page  (ultralytics#8900)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update Docs README (ultralytics#8919)

* Fix `names` bug when exporting YOLOv8-World to ONNX (ultralytics#8941)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* New test for labels and crops (ultralytics#8861)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Optimize TFJS export on ARM64 (ultralytics#8946)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Auto-format by https://ultralytics.com/actions

* `ultralytics 8.1.28` avoid * ops on bool Tensors for RT-DETR OpenVINO export (ultralytics#8937)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add https://youtu.be/YDXKa1EljmU and https://youtu.be/5BO0Il_YYAg to Docs (ultralytics#8958)

* `ultralytics 8.1.29` improved disk space checking on correct path (ultralytics#8977)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Kayzwer <68285002+Kayzwer@users.noreply.github.com>

* Add OpenVINO Latency vs Throughput modes Docs page (ultralytics#9001)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add `brain-tumor` dataset docs page (ultralytics#9041)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix Neural Magic links (ultralytics#9144)

* Updating a typo on paddlepaddle.md (ultralytics#9108)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.30` add advanced HUB train arguments (ultralytics#9110)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* fix yolo classify model loading error (ultralytics#9196)

* Add TF GraphDef Docs Integrations Page (ultralytics#9203)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.31` NCNN and CLIP updates (ultralytics#9235)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix TypeError in check_cfg() (ultralytics#9245)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add https://youtu.be/aeAX6vWpfR0 to docs & `african-wildlife` dataset docs page (ultralytics#9102)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add TF SavedModel Docs Integrations Page (ultralytics#9162)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Limit `ray<2.9.3` due to bug in `ray==2.10.0` (ultralytics#9254)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.32` fix CLIP backwards compatibility (ultralytics#9253)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Conda cv2 ImportError libEGL.so.1 fix (ultralytics#9255)

* Fix `IS_PYTHON_3_12` bug (ultralytics#9258)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>

* Reverse IoU threshold for NMS docs descriptions (ultralytics#9151)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add `bgr` hyperparameter (ultralytics#9139)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update pyproject.toml `[tool.pytest.ini_options]` (ultralytics#9259)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix OpenVINO missing batch-size bug (ultralytics#9264)

* `ultralytics 8.1.33` fix HUB model checks (ultralytics#9153)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update Discord and Contributing Guide URLs (ultralytics#9270)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Add https://youtu.be/uDrn9QZJ2lk and `object_counting.py`, `ai_gym.py` updates (ultralytics#9265)

* `ultralytics 8.1.34` Inference API robust imgsz checks (ultralytics#9274)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Bump contributor-assistant/github-action from 2.3.1 to 2.3.2 in /.github/workflows (ultralytics#9279)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add https://youtu.be/u3pLlgzUeV8 to docs (ultralytics#9367)

* Fix typo in YOLOv8-Libtorch-CPP-Inference (ultralytics#9330)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Simplify metrics calculation (ultralytics#9338)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Fix typo in example readme (ultralytics#9306)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Specify YOLODataset task arg during INT8 calibration (ultralytics#9309)

Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* `ultralytics 8.1.35` simplify network modules (ultralytics#9321)

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>

---------

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Skillnoob <78843978+Skillnoob@users.noreply.github.com>
Co-authored-by: Muhammad Rizwan Munawar <chr043416@gmail.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com>
Co-authored-by: Abirami Vina <abirami.vina@gmail.com>
Co-authored-by: Paula Derrenger <107626595+pderrenger@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yonghye Kwon <developer.0hye@gmail.com>
Co-authored-by: Muhammad Rizwan Munawar <muhammadrizwanmunawar123@gmail.com>
Co-authored-by: WangQvQ <1579093407@qq.com>
Co-authored-by: Martin Pl <martin-plank@gmx.de>
Co-authored-by: Mactarvish <Mactarvish@users.noreply.github.com>
Co-authored-by: DieterTimmers <46112022+DieterTimmers@users.noreply.github.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
Co-authored-by: AdamP <7806910+adamp87@users.noreply.github.com>
Co-authored-by: Youho99 <44434482+Youho99@users.noreply.github.com>
Co-authored-by: Ankan Ghosh <79740115+0xSynapse@users.noreply.github.com>
Co-authored-by: Skillnoob <78843978+Skillnoob@users.noreply.github.com>
Co-authored-by: Burhan <62214284+Burhan-Q@users.noreply.github.com>
Co-authored-by: Priytosh Tripathi <priytosh.revolution@live.com>
Co-authored-by: Johannes Kaisinger <johannes.kaisinger@gmail.com>
Co-authored-by: Johnny <johnnynuca14@gmail.com>
Co-authored-by: Lakshantha Dissanayake <lakshanthad@yahoo.com>
Co-authored-by: Alexander Suslov <alexander.suslov@intel.com>
Co-authored-by: Chi <iamchi@skiff.com>
Co-authored-by: AlainSchoebi <44315825+AlainSchoebi@users.noreply.github.com>
Co-authored-by: Dean Mark <2552482+deanmark@users.noreply.github.com>
Co-authored-by: Yifei Liu <71677542+kaikai23@users.noreply.github.com>
Co-authored-by: Kayzwer <68285002+Kayzwer@users.noreply.github.com>
Co-authored-by: Robin Brown <birdcolour@users.noreply.github.com>
Co-authored-by: fang_chenfang <1217690899@qq.com>
Co-authored-by: Hassaan Farooq <103611273+hassaanfarooq01@users.noreply.github.com>
Co-authored-by: hassaanfarooq01 <hassaanfarooq01@gmail.com>
Co-authored-by: Omar Duhaiby <3omarz@gmail.com>
Co-authored-by: Andrew <ykk8j4yq@duck.com>
Co-authored-by: Sergiu Waxmann <47978446+sergiuwaxmann@users.noreply.github.com>
Co-authored-by: Adrian Boguszewski <adekboguszewski@gmail.com>
Co-authored-by: Henry <contact@henrynavarro.org>
Co-authored-by: bobyard-com <154289614+bobyard-com@users.noreply.github.com>
Co-authored-by: Mohammed Yasin <32206511+Y-T-G@users.noreply.github.com>
Co-authored-by: Finlay Morrison <57669260+finlaymorrison@users.noreply.github.com>
Co-authored-by: Massimiliano Riva <48362794+massimiliano96@users.noreply.github.com>
Co-authored-by: Jamjamjon <51357717+jamjamjon@users.noreply.github.com>
Co-authored-by: Kalen Michael <kalenmike@gmail.com>
Co-authored-by: Mo Li <82895469+DseidLi@users.noreply.github.com>
Co-authored-by: zhaoruibing <zhaoruibing@gmail.com>
Co-authored-by: Dzmitry Plashchynski <plashchynski@gmail.com>
Co-authored-by: higor-melo <115033428+higor-melo@users.noreply.github.com>
Co-authored-by: Eric Hanson <5846501+ericphanson@users.noreply.github.com>
Co-authored-by: sifan-intel <109498696+sifan-intel@users.noreply.github.com>
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
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants