Skip to content
This repository was archived by the owner on Feb 5, 2025. It is now read-only.

Commit 1455c35

Browse files
vladmandicvladmandic
committed
update typedoc
1 parent 953ef70 commit 1455c35

File tree

69 files changed

+3777
-3213
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+3777
-3213
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Repository: **<git+https://github.com/vladmandic/face-api.git>**
99

1010
## Changelog
1111

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

1414

15-
### **origin/master** 2021/06/04 [email protected]
15+
### **1.3.1** 2021/06/08 [email protected]
1616

1717
- fix face expression detection (#56)
1818
- add buffertovideo

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ Compared to [face-api.js](https://github.com/justadudewhohacks/face-api.js) vers
443443
- Compatible with `TensorFlow/JS 2.0+ & 3.0+`
444444
- Compatible with `WebGL`, `CPU` and `WASM` TFJS Browser backends
445445
- Compatible with both `tfjs-node` and `tfjs-node-gpu` TFJS NodeJS backends
446-
- Updated all type castings for TypeScript type checking to `TypeScript 4.2`
446+
- Updated all type castings for TypeScript type checking to `TypeScript 4.3`
447447
- Switched bundling from `UMD` to `ESM` + `CommonJS` with fallback to `IIFE`
448448
Resulting code is optimized per-platform instead of being universal
449449
Fully tree shakable when imported as an `ESM` module

‎package.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@
4747
"@tensorflow/tfjs-backend-wasm": "^3.7.0",
4848
"@tensorflow/tfjs-node": "^3.7.0",
4949
"@tensorflow/tfjs-node-gpu": "^3.7.0",
50-
"@types/node": "^15.12.2",
51-
"@typescript-eslint/eslint-plugin": "^4.26.1",
52-
"@typescript-eslint/parser": "^4.26.1",
50+
"@types/node": "^15.12.3",
51+
"@typescript-eslint/eslint-plugin": "^4.27.0",
52+
"@typescript-eslint/parser": "^4.27.0",
5353
"@vladmandic/pilogger": "^0.2.17",
5454
"canvas": "^2.8.0",
55-
"chokidar": "^3.5.1",
55+
"chokidar": "^3.5.2",
5656
"dayjs": "^1.10.5",
57-
"esbuild": "^0.12.7",
57+
"esbuild": "^0.12.9",
5858
"eslint": "^7.28.0",
5959
"eslint-config-airbnb-base": "^14.2.1",
6060
"eslint-plugin-import": "^2.23.4",
@@ -64,9 +64,9 @@
6464
"node-fetch": "^2.6.1",
6565
"rimraf": "^3.0.2",
6666
"seedrandom": "^3.0.5",
67-
"simple-git": "^2.39.0",
68-
"tslib": "^2.2.0",
69-
"typedoc": "^0.21.0-beta.2",
70-
"typescript": "4.3.2"
67+
"simple-git": "^2.40.0",
68+
"tslib": "^2.3.0",
69+
"typedoc": "^0.21.0",
70+
"typescript": "4.3.4"
7171
}
7272
}

‎typedoc/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎typedoc/classes/agegendernet.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@vladmandic/face-api</a>
53+
<a href="../modules.html">@vladmandic/face-api</a>
5454
</li>
5555
<li>
5656
<a href="agegendernet.html">AgeGenderNet</a>
@@ -67,7 +67,7 @@ <h1>Class AgeGenderNet</h1>
6767
<h3>Hierarchy</h3>
6868
<ul class="tsd-hierarchy">
6969
<li>
70-
<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>
70+
<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>
7171
<ul class="tsd-hierarchy">
7272
<li>
7373
<span class="target">AgeGenderNet</span>
@@ -271,7 +271,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
271271
<a name="extractclassifierparams" class="tsd-anchor"></a>
272272
<h3>extract<wbr>Classifier<wbr>Params</h3>
273273
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
274-
<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>
274+
<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>
275275
</ul>
276276
<ul class="tsd-descriptions">
277277
<li class="tsd-description">
@@ -286,13 +286,13 @@ <h4 class="tsd-parameters-title">Parameters</h4>
286286
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
287287
</li>
288288
</ul>
289-
<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>
289+
<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>
290290
<ul class="tsd-parameters">
291291
<li class="tsd-parameter">
292292
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
293293
</li>
294294
<li class="tsd-parameter">
295-
<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>
295+
<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>
296296
</li>
297297
</ul>
298298
</li>
@@ -326,7 +326,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
326326
<a name="forward" class="tsd-anchor"></a>
327327
<h3>forward</h3>
328328
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
329-
<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>
329+
<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>
330330
</ul>
331331
<ul class="tsd-descriptions">
332332
<li class="tsd-description">
@@ -341,15 +341,15 @@ <h4 class="tsd-parameters-title">Parameters</h4>
341341
<h5>input: <span class="tsd-signature-type">any</span></h5>
342342
</li>
343343
</ul>
344-
<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>
344+
<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>
345345
</li>
346346
</ul>
347347
</section>
348348
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
349349
<a name="forwardinput" class="tsd-anchor"></a>
350350
<h3>forward<wbr>Input</h3>
351351
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
352-
<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>
352+
<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>
353353
</ul>
354354
<ul class="tsd-descriptions">
355355
<li class="tsd-description">
@@ -364,7 +364,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
364364
<h5>input: <span class="tsd-signature-type">any</span></h5>
365365
</li>
366366
</ul>
367-
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
367+
<h4 class="tsd-returns-title">Returns <a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
368368
</li>
369369
</ul>
370370
</section>
@@ -587,7 +587,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
587587
<a name="predictageandgender" class="tsd-anchor"></a>
588588
<h3>predict<wbr>Age<wbr>And<wbr>Gender</h3>
589589
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
590-
<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>
590+
<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>
591591
</ul>
592592
<ul class="tsd-descriptions">
593593
<li class="tsd-description">
@@ -602,7 +602,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
602602
<h5>input: <span class="tsd-signature-type">any</span></h5>
603603
</li>
604604
</ul>
605-
<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>
605+
<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>
606606
</li>
607607
</ul>
608608
</section>
@@ -637,7 +637,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
637637
<a name="runnet" class="tsd-anchor"></a>
638638
<h3>run<wbr>Net</h3>
639639
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
640-
<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>
640+
<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>
641641
</ul>
642642
<ul class="tsd-descriptions">
643643
<li class="tsd-description">
@@ -652,7 +652,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
652652
<h5>input: <span class="tsd-signature-type">any</span></h5>
653653
</li>
654654
</ul>
655-
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
655+
<h4 class="tsd-returns-title">Returns <a href="../modules.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
656656
</li>
657657
</ul>
658658
</section>
@@ -698,7 +698,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
698698
<nav class="tsd-navigation primary">
699699
<ul>
700700
<li class=" ">
701-
<a href="../index.html">Exports</a>
701+
<a href="../modules.html">Exports</a>
702702
</li>
703703
</ul>
704704
</nav>

‎typedoc/classes/boundingbox.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@vladmandic/face-api</a>
53+
<a href="../modules.html">@vladmandic/face-api</a>
5454
</li>
5555
<li>
5656
<a href="boundingbox.html">BoundingBox</a>
@@ -700,7 +700,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
700700
<nav class="tsd-navigation primary">
701701
<ul>
702702
<li class=" ">
703-
<a href="../index.html">Exports</a>
703+
<a href="../modules.html">Exports</a>
704704
</li>
705705
</ul>
706706
</nav>

‎typedoc/classes/box.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@vladmandic/face-api</a>
53+
<a href="../modules.html">@vladmandic/face-api</a>
5454
</li>
5555
<li>
5656
<a href="box.html">Box</a>
@@ -704,7 +704,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
704704
<nav class="tsd-navigation primary">
705705
<ul>
706706
<li class=" ">
707-
<a href="../index.html">Exports</a>
707+
<a href="../modules.html">Exports</a>
708708
</li>
709709
</ul>
710710
</nav>

‎typedoc/classes/composabletask.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@vladmandic/face-api</a>
53+
<a href="../modules.html">@vladmandic/face-api</a>
5454
</li>
5555
<li>
5656
<a href="composabletask.html">ComposableTask</a>
@@ -199,7 +199,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
199199
<nav class="tsd-navigation primary">
200200
<ul>
201201
<li class=" ">
202-
<a href="../index.html">Exports</a>
202+
<a href="../modules.html">Exports</a>
203203
</li>
204204
</ul>
205205
</nav>

0 commit comments

Comments
 (0)