Skip to content
This repository has been archived by the owner on Sep 23, 2024. It is now read-only.

Commit

Permalink
update typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@vladmandic
vladmandic committed Jun 18, 2021
1 parent 953ef70 commit 1455c35
Show file tree
Hide file tree
Showing 69 changed files with 3,777 additions and 3,213 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Repository: **<git+https://github.com/vladmandic/face-api.git>**

## Changelog

### **1.3.1** 2021/06/08 [email protected]
### **HEAD -> master** 2021/06/08 [email protected]


### **origin/master** 2021/06/04 [email protected]
### **1.3.1** 2021/06/08 [email protected]

- fix face expression detection (#56)
- add buffertovideo
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ Compared to [face-api.js](https://github.com/justadudewhohacks/face-api.js) vers
- Compatible with `TensorFlow/JS 2.0+ & 3.0+`
- Compatible with `WebGL`, `CPU` and `WASM` TFJS Browser backends
- Compatible with both `tfjs-node` and `tfjs-node-gpu` TFJS NodeJS backends
- Updated all type castings for TypeScript type checking to `TypeScript 4.2`
- Updated all type castings for TypeScript type checking to `TypeScript 4.3`
- Switched bundling from `UMD` to `ESM` + `CommonJS` with fallback to `IIFE`
Resulting code is optimized per-platform instead of being universal
Fully tree shakable when imported as an `ESM` module
Expand Down
18 changes: 9 additions & 9 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@
"@tensorflow/tfjs-backend-wasm": "^3.7.0",
"@tensorflow/tfjs-node": "^3.7.0",
"@tensorflow/tfjs-node-gpu": "^3.7.0",
"@types/node": "^15.12.2",
"@typescript-eslint/eslint-plugin": "^4.26.1",
"@typescript-eslint/parser": "^4.26.1",
"@types/node": "^15.12.3",
"@typescript-eslint/eslint-plugin": "^4.27.0",
"@typescript-eslint/parser": "^4.27.0",
"@vladmandic/pilogger": "^0.2.17",
"canvas": "^2.8.0",
"chokidar": "^3.5.1",
"chokidar": "^3.5.2",
"dayjs": "^1.10.5",
"esbuild": "^0.12.7",
"esbuild": "^0.12.9",
"eslint": "^7.28.0",
"eslint-config-airbnb-base": "^14.2.1",
"eslint-plugin-import": "^2.23.4",
Expand All @@ -64,9 +64,9 @@
"node-fetch": "^2.6.1",
"rimraf": "^3.0.2",
"seedrandom": "^3.0.5",
"simple-git": "^2.39.0",
"tslib": "^2.2.0",
"typedoc": "^0.21.0-beta.2",
"typescript": "4.3.2"
"simple-git": "^2.40.0",
"tslib": "^2.3.0",
"typedoc": "^0.21.0",
"typescript": "4.3.4"
}
}
2 changes: 1 addition & 1 deletion typedoc/assets/js/search.js
View file

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions typedoc/classes/agegendernet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
<a href="../modules.html">@vladmandic/face-api</a>
</li>
<li>
<a href="agegendernet.html">AgeGenderNet</a>
Expand All @@ -67,7 +67,7 @@ <h1>Class AgeGenderNet</h1>
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol">&gt;</span>
<a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AgeGenderNet</span>
Expand Down Expand Up @@ -271,7 +271,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></li>
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../modules.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -286,13 +286,13 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../modules.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a></h5>
<h5>params<span class="tsd-signature-symbol">: </span><a href="../modules.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a></h5>
</li>
</ul>
</li>
Expand Down Expand Up @@ -326,7 +326,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -341,15 +341,15 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -364,7 +364,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
<h4 class="tsd-returns-title">Returns <a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
</li>
</ul>
</section>
Expand Down Expand Up @@ -587,7 +587,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="predictageandgender" class="tsd-anchor"></a>
<h3>predict<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">predict<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">predict<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -602,7 +602,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand Down Expand Up @@ -637,7 +637,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -652,7 +652,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
<h4 class="tsd-returns-title">Returns <a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
</li>
</ul>
</section>
Expand Down Expand Up @@ -698,7 +698,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions typedoc/classes/boundingbox.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
<a href="../modules.html">@vladmandic/face-api</a>
</li>
<li>
<a href="boundingbox.html">BoundingBox</a>
Expand Down Expand Up @@ -700,7 +700,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions typedoc/classes/box.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
<a href="../modules.html">@vladmandic/face-api</a>
</li>
<li>
<a href="box.html">Box</a>
Expand Down Expand Up @@ -704,7 +704,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions typedoc/classes/composabletask.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
<a href="../modules.html">@vladmandic/face-api</a>
</li>
<li>
<a href="composabletask.html">ComposableTask</a>
Expand Down Expand Up @@ -199,7 +199,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
Expand Down
Loading

0 comments on commit 1455c35

Please sign in to comment.