Skip to content

Documentation for Yolo usage in Opencv#24898

Merged
asmorkalov merged 12 commits intoopencv:4.xfrom
Abdurrahheem:ash/yolo_ducumentation
Jan 31, 2024
Merged

Documentation for Yolo usage in Opencv#24898
asmorkalov merged 12 commits intoopencv:4.xfrom
Abdurrahheem:ash/yolo_ducumentation

Conversation

@Abdurrahheem
Copy link
Copy Markdown
Contributor

@Abdurrahheem Abdurrahheem commented Jan 21, 2024

This PR introduces documentation for the usage of yolo detection model family in open CV. This is not to be merge before #24691, as the sample will need to be changed.

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
  • The PR is proposed to the proper branch
  • There is a reference to the original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

@Abdurrahheem Abdurrahheem self-assigned this Jan 21, 2024
asmorkalov
asmorkalov reviewed Jan 22, 2024
View reviewed changes
dkurt
dkurt reviewed Jan 22, 2024
View reviewed changes
@Abdurrahheem Abdurrahheem force-pushed the ash/yolo_ducumentation branch 2 times, most recently from 35c45a1 to 4dc6d95 Compare January 24, 2024 16:49
asmorkalov
asmorkalov reviewed Jan 25, 2024
View reviewed changes
@asmorkalov asmorkalov added this to the 4.10.0 milestone Jan 25, 2024
@asmorkalov asmorkalov added category: documentation Documentation fix or update category: dnn labels Jan 25, 2024
@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented Jan 25, 2024

General notes:

  • use the same name spelling, e.g. YOLO, Yolo yolox, etc.
  • drop xml/html comments
  • cut lines e.g. 100 symbols to be readable in console. Also it simplifies review.

@Abdurrahheem Abdurrahheem force-pushed the ash/yolo_ducumentation branch from 4dc6d95 to 566cefc Compare January 26, 2024 03:51
@asmorkalov asmorkalov marked this pull request as ready for review January 26, 2024 13:47
@asmorkalov asmorkalov force-pushed the ash/yolo_ducumentation branch from 6bd2544 to 0a64eec Compare January 27, 2024 10:39
@asmorkalov asmorkalov force-pushed the ash/yolo_ducumentation branch from 0a64eec to 6d39e3f Compare January 27, 2024 11:34
dkurt
dkurt reviewed Jan 29, 2024
View reviewed changes
@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented Jan 29, 2024

@Abdurrahheem I reformated text a bit and fixed warnings. I propose to add default values for parameters. There is download_models.py script to download files and there is cv::samples::findFile function to find default input image and model files: https://docs.opencv.org/4.x/d6/dba/group__core__utils__samples.html#ga3a33b00033b46c698ff6340d95569c13

@Abdurrahheem
Copy link
Copy Markdown
Contributor Author

Abdurrahheem commented Jan 29, 2024

Thank you!

Working on it

@asmorkalov
Copy link
Copy Markdown
Contributor

asmorkalov commented Jan 30, 2024

@Abdurrahheem I fixed the branch with VideoCapture (camera/video) and removed default image from parameters. It makes streaming branch unavailable. Also I fixed code formatting here and there. Sample tested manually with Ubuntu 20.04.

asmorkalov
asmorkalov approved these changes Jan 30, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@asmorkalov asmorkalov merged commit 372b36c into opencv:4.x Jan 31, 2024
This was referenced Feb 3, 2024
Closed
Closed
Closed
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asmorkalov asmorkalov asmorkalov approved these changes

@dkurt dkurt dkurt left review comments

Assignees

@asmorkalov asmorkalov

Labels

category: dnn category: documentation Documentation fix or update

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

3 participants

@Abdurrahheem @asmorkalov @dkurt