Skip to content

Update documentation #20957

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Nov 28, 2021
Merged

Update documentation #20957

merged 3 commits into from
Nov 28, 2021

Conversation

sturkmen72
Copy link
Contributor

additional documentation improvements relates #20935

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 other license that is incompatible with OpenCV
  • The PR is proposed to proper branch
  • There is reference to 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
force_builders_only=linux,docs

@alalek
Copy link
Member

alalek commented Oct 27, 2021

/cc @fengyuentau @crywang

Live demo.

@fengyuentau
Copy link
Member

Thanks for showing us how this kind of live demo works. When we were composing this tutorial, we just followed the writing format of tutorial_dnn_text_spotting.html.

@sturkmen72 sturkmen72 changed the title Update documentation WIP - Update documentation Oct 28, 2021
@sturkmen72
Copy link
Contributor Author

@fengyuentau i am still working on the PR. i will ping you for final review. ( Thank you for a GREATE contribution )

@sturkmen72 sturkmen72 force-pushed the update-documentation branch from 2427f28 to 8fbb807 Compare October 29, 2021 10:24
@crywang
Copy link
Contributor

crywang commented Oct 29, 2021

I wish to thank you sincerely for your demonstration and contribution on improving the writing format of document.

@sturkmen72
Copy link
Contributor Author

@alalek @fengyuentau @crywang in my opinion, combining detection and recognition parts in only one sample will be fine. what is your opinions?

@fengyuentau
Copy link
Member

I think combining two samples into one may confuse people who want to know how to use face detection separately. The original sample is simple enough to show people how to do so.

Also, in my opinion, you should also compose a subsection for FaceRecognizerSF as what you did for FaceDetectorYN:

## Usage
### FaceDetectorYN
Code
-----
Explanation
-----
### FaceRecognizerSF
Code
-----
Explanation
-----

@sturkmen72 sturkmen72 force-pushed the update-documentation branch 3 times, most recently from b3baf96 to d33bb10 Compare October 30, 2021 12:30
@sturkmen72
Copy link
Contributor Author

@fengyuentau i combined face_match functionality into face_detect just for presentation.

if image1 and image2 parameters given then face matching will run.
anyway I can revert combination idea if you don't like.

alalek
alalek reviewed Nov 23, 2021
View reviewed changes
Copy link
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

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

Thank you for contribution!

samples/dnn/face_detect.cpp Outdated
for (int i = 0; i < faces.rows; i++)
{
// Print results
cout << "Face " << i
<< ", top-left coordinates: (" << faces.at<float>(i, 0) << ", " << faces.at<float>(i, 1) << "), "
<< "box width: " << faces.at<float>(i, 2) << ", box height: " << faces.at<float>(i, 3) << ", "
<< "score: " << faces.at<float>(i, 14) << "\n";
<< "score: " << format("%.2f\n", faces.at<float>(i, 14));
Copy link
Member

Choose a reason for hiding this comment

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

format

please use cv::format() to avoid issues with latest C++ and std::format.

@alalek
Copy link
Member

alalek commented Nov 25, 2021 •
edited
Loading

Updated .cpp sample.

@sturkmen72 Please take a look and remove WIP prefix from PR's title.

@sturkmen72 sturkmen72 changed the title WIP - Update documentation Update documentation Nov 25, 2021
alalek
alalek approved these changes Nov 28, 2021
View reviewed changes
Copy link
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

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

Well done! Thank you 👍

@alalek alalek merged commit a97f21b into opencv:4.x Nov 28, 2021
@sturkmen72 sturkmen72 deleted the update-documentation branch November 28, 2021 14:28
@alalek alalek mentioned this pull request Dec 30, 2021
Merged
@alalek alalek mentioned this pull request Feb 22, 2022
Merged
a-sajjad72 pushed a commit to a-sajjad72/opencv that referenced this pull request Mar 30, 2023
@sturkmen72 @alalek
Merge pull request opencv#20957 from sturkmen72:update-documentation
fe31822 
Update documentation

* Update DNN-based Face Detection And Recognition tutorial

* samples(dnn/face): update face_detect.cpp

* final changes

Co-authored-by: Alexander Alekhin <alexander.a.alekhin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alalek alalek alalek approved these changes

Assignees

@alalek alalek

Labels
category: documentation Documentation fix or update
Projects
None yet
Milestone
4.5.5
Development

Successfully merging this pull request may close these issues.
4 participants
@sturkmen72 @alalek @fengyuentau @crywang