diff --git a/Configuration.md b/Configuration.md index c3133ab..3d4ce34 100644 --- a/Configuration.md +++ b/Configuration.md @@ -156,29 +156,6 @@ const config: Config = { modelPath: 'emotion.json', // face emotion model // can be either absolute path or relative to modelBasePath }, - - age: { - enabled: false, // obsolete, replaced by description module - modelPath: 'age.json', // age model - // can be either absolute path or relative to modelBasePath - skipFrames: 33, // how many frames to go without re-running the detector - // only used for video inputs - }, - - gender: { - enabled: false, // obsolete, replaced by description module - minConfidence: 0.1, // threshold for discarding a prediction - modelPath: 'gender.json', // gender model - // can be either absolute path or relative to modelBasePath - skipFrames: 34, // how many frames to go without re-running the detector - // only used for video inputs - }, - - embedding: { - enabled: false, // obsolete, replaced by description module - modelPath: 'mobileface.json', // face descriptor model - // can be either absolute path or relative to modelBasePath - }, }, body: { diff --git a/Embedding.md b/Embedding.md index 0e458b7..a508400 100644 --- a/Embedding.md +++ b/Embedding.md @@ -15,7 +15,7 @@ It highlights functionality such as: ## Usage -To use face simmilaity compare feature, you must first enable `face.embedding` module +To use face simmilaity compare feature, you must first enable `face.description` module and calculate embedding vectors for both first and second image you want to compare To achieve quality results, it is also highly recommended to have `face.mesh` and `face.detection.rotation` @@ -32,7 +32,6 @@ const myConfig = { detector: { rotation: true, return: true }, mesh: { enabled: true }, description: { enabled: true }, - // embedding: { enabled: true }, // alternative you can use embedding module instead of description }, }; diff --git a/Usage.md b/Usage.md index a296460..a36d4b6 100644 --- a/Usage.md +++ b/Usage.md @@ -25,7 +25,7 @@ or if you want to use promises }) ``` -Additionally, `Human` library exposes several objects and methods: +`Human` library exposes several additional objects and methods: ```js human.version // string containing version of human library @@ -39,20 +39,15 @@ Additionally, `Human` library exposes several objects and methods: human.image(image, config?) // runs image processing without detection and returns canvas human.warmup(config, image? // warms up human library for faster initial execution after loading // if image is not provided, it will generate internal sample - human.similarity(embedding1, embedding2) // runs similarity calculation between two provided embedding vectors - // vectors for source and target must be previously detected using - // face.embedding module - human.enhance(face) // returns enhanced tensor of a previously detected face that can be used for visualizations ``` Additional functions used for face recognition: For details, see [embedding documentation](https://github.com/vladmandic/human/wiki/Embedding) - ```js human.similarity(embedding1, embedding2) // runs similarity calculation between two provided embedding vectors // vectors for source and target must be previously detected using - // face.embedding module + // face.description module human.match(embedding, db, threshold) // finds best match for current face in a provided list of faces human.enhance(face) // returns enhanced tensor of a previously detected face that can be used for visualizations ```