ambiser
/
human
mirror of https://github.com/vladmandic/human
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated readme

pull/50/head
Vladimir Mandic 2020-10-12 14:46:08 -04:00
parent 6edeea1afb
commit c3d1b60398
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -122,7 +122,7 @@ import human from '@vladmandic/human';
// 'image': can be of any type of an image object: HTMLImage, HTMLVideo, HTMLMedia, Canvas, Tensor4D // 'image': can be of any type of an image object: HTMLImage, HTMLVideo, HTMLMedia, Canvas, Tensor4D
// 'options': optional parameter used to override any options present in default configuration // 'options': optional parameter used to override any options present in default configuration
const results = await human.detect(image, options?) const result = await human.detect(image, options?)
``` ```
Additionally, `Human` library exposes several classes: Additionally, `Human` library exposes several classes:
@ -146,7 +146,7 @@ human.defaults = {
face: { face: {
enabled: true, enabled: true,
detector: { detector: {
modelPath: '../models/human/blazeface/model.json', modelPath: '../models/blazeface/model.json',
maxFaces: 10, maxFaces: 10,
skipFrames: 5, skipFrames: 5,
minConfidence: 0.8, minConfidence: 0.8,
@ -155,25 +155,25 @@ human.defaults = {
}, },
mesh: { mesh: {
enabled: true, enabled: true,
modelPath: '../models/human/facemesh/model.json', modelPath: '../models/facemesh/model.json',
}, },
iris: { iris: {
enabled: true, enabled: true,
modelPath: '../models/human/iris/model.json', modelPath: '../models/iris/model.json',
}, },
age: { age: {
enabled: true, enabled: true,
modelPath: '../models/human/ssrnet-imdb-age/model.json', modelPath: '../models/ssrnet-imdb-age/model.json',
skipFrames: 5, skipFrames: 5,
}, },
gender: { gender: {
enabled: true, enabled: true,
modelPath: '../models/human/ssrnet-imdb-gender/model.json', modelPath: '../models/ssrnet-imdb-gender/model.json',
}, },
}, },
body: { body: {
enabled: true, enabled: true,
modelPath: '../models/human/posenet/model.json', modelPath: '../models/posenet/model.json',
maxDetections: 5, maxDetections: 5,
scoreThreshold: 0.75, scoreThreshold: 0.75,
nmsRadius: 20, nmsRadius: 20,
@ -185,11 +185,11 @@ human.defaults = {
iouThreshold: 0.3, iouThreshold: 0.3,
scoreThreshold: 0.75, scoreThreshold: 0.75,
detector: { detector: {
anchors: '../models/human/handdetect/anchors.json', anchors: '../models/handdetect/anchors.json',
modelPath: '../models/human/handdetect/model.json', modelPath: '../models/handdetect/model.json',
}, },
skeleton: { skeleton: {
modelPath: '../models/human/handskeleton/model.json', modelPath: '../models/handskeleton/model.json',
}, },
}, },
}; };
@ -249,6 +249,7 @@ result = {
## Build ## Build
If you want to modify the library and perform a full rebuild: If you want to modify the library and perform a full rebuild:
*clone repository, install dependencies, check for errors and run full rebuild from which creates bundles from `/src` into `/dist`:* *clone repository, install dependencies, check for errors and run full rebuild from which creates bundles from `/src` into `/dist`:*
```shell ```shell
@ -259,9 +260,10 @@ npm run lint
npm run build npm run build
``` ```
Project is written in pure `JavaScript`, [ECMAScript version 2020](https://www.ecma-international.org/ecma-262/11.0/index.html) Project is written in pure `JavaScript` [ECMAScript version 2020](https://www.ecma-international.org/ecma-262/11.0/index.html)
Only project depdendency is [@tensorflow/tfjs](https://github.com/tensorflow/tfjs), the rest are devDependencies tools: [eslint](https://github.com/eslint) used for linting and [esbuild](https://github.com/evanw/esbuild) used for bundling Only project depdendency is [@tensorflow/tfjs](https://github.com/tensorflow/tfjs)
Development dependencies are [eslint](https://github.com/eslint) used for code linting and [esbuild](https://github.com/evanw/esbuild) used for IIFE and ESM script bundling
<hr> <hr>