Add docs for Handpose model #1067
Conversation
docs/reference/facemesh.md
Outdated
| @@ -51,7 +51,7 @@ const facemesh = ml5.facemesh(?video, ?options, ?callback); | |||
| detectionConfidence: 0.9, // Threshold for discarding a prediction. Defaults to 0.9. | |||
| maxFaces: 10, // The maximum number of faces detected in the input. Should be set to the minimum number for performance. Defaults to 10. | |||
| iouThreshold: 0.3, // A float representing the threshold for deciding whether boxes overlap too much in non-maximum suppression. Must be between [0, 1]. Defaults to 0.3. | |||
| scoreThreshold: 0.75, // defaults to 0.75 | |||
| scoreThreshold: 0.75, // A threshold for deciding when to remove boxes based on score in non-maximum suppression. Defaults to 0.75 | |||
There was a problem hiding this comment.
Noting here that score in non-maximum suppression is not familiar terminology. Looking it up myself I just watched a bit of this video https://www.coursera.org/lecture/convolutional-neural-networks/non-max-suppression-dvrjH. We could refer to a resource and/or simplify the language to something like:
// threshold for removing multiple (likely duplicate) detections
or
// threshold for removing multiple (likely duplicate) detections based on a "non-maximum suppression" algorithm.
There was a problem hiding this comment.
+1 for // threshold for removing multiple (likely duplicate) detections based on a "non-maximum suppression" algorithm.
| ## Tutorials | ||
|
|
||
| No tutorials yet - contribute one today! | ||
|
|
There was a problem hiding this comment.
We should add in the placeholder for the Data and Model Provenance work that @ellennickles has done for the other features: e.g. https://github.com/ml5js/ml5-library/pull/1047/files#diff-8eef2538dbb4d1c92215a82d44c7fa2cR166
There was a problem hiding this comment.
LGTM! I added one non-blocking comment regarding the data and model provenance work from @ellennickles and added a +1 to Dan's suggestion about a comment to explain the non-max suppression parameter.
Nice work!
… non-maximum suppression on the Facemesh & Handpose docs
This PR introduces a documentation page for the Handpose model. While here, I also made some fixes to the Facemesh documentation to correct some typos I had accidentally left in that documentation.