update docs

master
Vladimir Mandic 2021-03-29 14:40:08 -04:00
parent aae30ba390
commit df23c6e6fd
2 changed files with 12 additions and 10 deletions

@ -134,7 +134,7 @@ const config: Config = {
}, },
description: { description: {
enabled: true, // to improve accuracy of face embedding extraction it is enabled: true, // to improve accuracy of face description extraction it is
// recommended to enable detector.rotation and mesh.enabled // recommended to enable detector.rotation and mesh.enabled
modelPath: '../models/faceres.json', modelPath: '../models/faceres.json',
skipFrames: 31, // how many frames to go without re-running the detector skipFrames: 31, // how many frames to go without re-running the detector
@ -144,14 +144,14 @@ const config: Config = {
emotion: { emotion: {
enabled: true, enabled: true,
minConfidence: 0.1, // threshold for discarding a prediction minConfidence: 0.1, // threshold for discarding a prediction
skipFrames: 33, // how many frames to go without re-running the detector skipFrames: 32, // how many frames to go without re-running the detector
modelPath: '../models/emotion.json', modelPath: '../models/emotion.json',
}, },
age: { age: {
enabled: false, // obsolete, replaced by description module enabled: false, // obsolete, replaced by description module
modelPath: '../models/age.json', modelPath: '../models/age.json',
skipFrames: 31, // how many frames to go without re-running the detector skipFrames: 33, // how many frames to go without re-running the detector
// only used for video inputs // only used for video inputs
}, },
@ -159,7 +159,7 @@ const config: Config = {
enabled: false, // obsolete, replaced by description module enabled: false, // obsolete, replaced by description module
minConfidence: 0.1, // threshold for discarding a prediction minConfidence: 0.1, // threshold for discarding a prediction
modelPath: '../models/gender.json', modelPath: '../models/gender.json',
skipFrames: 32, // how many frames to go without re-running the detector skipFrames: 34, // how many frames to go without re-running the detector
// only used for video inputs // only used for video inputs
}, },
@ -171,7 +171,8 @@ const config: Config = {
body: { body: {
enabled: true, enabled: true,
modelPath: '../models/posenet.json', // can be 'posenet' or 'blazepose' modelPath: '../models/posenet.json', // can be 'posenet', 'blazepose' or 'efficientpose'
// 'blazepose' and 'efficientpose' are experimental
maxDetections: 10, // maximum number of people detected in the input maxDetections: 10, // maximum number of people detected in the input
// should be set to the minimum number for performance // should be set to the minimum number for performance
// only valid for posenet as blazepose only detects single pose // only valid for posenet as blazepose only detects single pose
@ -212,11 +213,12 @@ const config: Config = {
object: { object: {
enabled: false, enabled: false,
modelPath: '../models/nanodet.json', modelPath: '../models/nanodet.json',
minConfidence: 0.15, // threshold for discarding a prediction // 'nanodet' is experimental
iouThreshold: 0.25, // threshold for deciding whether boxes overlap too much minConfidence: 0.20, // threshold for discarding a prediction
iouThreshold: 0.40, // threshold for deciding whether boxes overlap too much
// in non-maximum suppression // in non-maximum suppression
maxResults: 10, // maximum number of objects detected in the input maxResults: 10, // maximum number of objects detected in the input
skipFrames: 13, // how many frames to go without re-running the detector skipFrames: 41, // how many frames to go without re-running the detector
}, },
}; };
``` ```

@ -129,11 +129,11 @@ Last parameter is optional and notes a minimal threshold for a match
Database can be further stored in a JS or JSON file and retrieved when needed to have Database can be further stored in a JS or JSON file and retrieved when needed to have
a permanent database of faces that can be expanded over time to cover any number of known faces a permanent database of faces that can be expanded over time to cover any number of known faces
For example, see `/demo/facematch.js` and example database `/demo/faces.json`: For example, see `/demo/facematch.js` and example database `/demo/facematch-faces.json`:
```js ```js
// download db with known faces // download db with known faces
let res = await fetch('/demo/faces.json'); let res = await fetch('/demo/facematch-faces.json');
db = (res && res.ok) ? await res.json() : []; db = (res && res.ok) ? await res.json() : [];
``` ```