face-api/typedoc/classes/FaceDetectionNet.html

715 lines
45 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceDetectionNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="FaceDetectionNet.html">FaceDetectionNet</a>
</li>
</ul>
<h1>Class FaceDetectionNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="SsdMobilenetv1.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceDetectionNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#isLoaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#paramMappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#extractWeights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#forwardInput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#getFrozenParams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#getParamFromPath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#getParamList" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#getTrainableParams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#loadFromDisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#loadFromUri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#loadFromWeightMap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#locateFaces" class="tsd-kind-icon">locate<wbr>Faces</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#reassignParamFromPath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#serializeParams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetectionNet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Detection<wbr>Net<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FaceDetectionNet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetectionNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L17">ssdMobilenetv1/SsdMobilenetv1.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="FaceDetectionNet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetectionNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isLoaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="paramMappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractWeights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<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-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#extractWeights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#forward">forward</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L33">ssdMobilenetv1/SsdMobilenetv1.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardInput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="NetInput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#forwardInput">forwardInput</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L21">ssdMobilenetv1/SsdMobilenetv1.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="NetInput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getFrozenParams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#getFrozenParams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getParamFromPath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#getParamFromPath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getParamList" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#getParamList">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getTrainableParams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#getTrainableParams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadFromDisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#loadFromDisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadFromUri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#loadFromUri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadFromWeightMap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#loadFromWeightMap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="locateFaces" class="tsd-anchor"></a>
<h3>locate<wbr>Faces</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">locate<wbr>Faces<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ISsdMobilenetv1Options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><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="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#locateFaces">locateFaces</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L37">ssdMobilenetv1/SsdMobilenetv1.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../interfaces/ISsdMobilenetv1Options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol"> = {}</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="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignParamFromPath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#reassignParamFromPath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeParams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#serializeParams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="FaceDetectionNet.html" class="tsd-kind-icon">Face<wbr>Detection<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#isLoaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#paramMappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#extractWeights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#forwardInput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#getFrozenParams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#getParamFromPath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#getParamList" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#getTrainableParams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#loadFromDisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#loadFromUri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#loadFromWeightMap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#locateFaces" class="tsd-kind-icon">locate<wbr>Faces</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#reassignParamFromPath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#serializeParams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetectionNet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>