face-api/typedoc/classes/TinyYolov2.html

32 lines
82 KiB
HTML
Raw Normal View History

2024-01-17 22:56:53 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TinyYolov2 | @vladmandic/face-api - v1.7.13</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/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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 - v1.7.13</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@vladmandic/face-api</a></li><li><a href="TinyYolov2.html">TinyYolov2</a></li></ul><h1>Class TinyYolov2</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TinyYolov2Base</span><ul class="tsd-hierarchy"><li><span class="target">TinyYolov2</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/tinyYolov2/TinyYolov2.ts#L18">src/tinyYolov2/TinyYolov2.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="TinyYolov2.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="TinyYolov2.html#_name" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_name</span></a>
<a href="TinyYolov2.html#DEFAULT_FILTER_SIZES" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>DEFAULT_<wbr/>FILTER_<wbr/>SIZES</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="TinyYolov2.html#anchors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>anchors</span></a>
<a href="TinyYolov2.html#boxEncodingSize" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>box<wbr/>Encoding<wbr/>Size</span></a>
<a href="TinyYolov2.html#config" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>config</span></a>
<a href="TinyYolov2.html#isLoaded" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>is<wbr/>Loaded</span></a>
<a href="TinyYolov2.html#paramMappings" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>param<wbr/>Mappings</span></a>
<a href="TinyYolov2.html#params" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>params</span></a>
<a href="TinyYolov2.html#withClassScores" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>with<wbr/>Class<wbr/>Scores</span></a>
<a href="TinyYolov2.html#withSeparableConvs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>with<wbr/>Separable<wbr/>Convs</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="TinyYolov2.html#detect" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>detect</span></a>
<a href="TinyYolov2.html#dispose" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dispose</span></a>
<a href="TinyYolov2.html#extractWeights" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>extract<wbr/>Weights</span></a>
<a href="TinyYolov2.html#forward" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>forward</span></a>
<a href="TinyYolov2.html#forwardInput" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>forward<wbr/>Input</span></a>
<a href="TinyYolov2.html#freeze" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>freeze</span></a>
<a href="TinyYolov2.html#getFrozenParams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Frozen<wbr/>Params</span></a>
<a href="TinyYolov2.html#getParamFromPath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Param<wbr/>From<wbr/>Path</span></a>
<a href="TinyYolov2.html#getParamList" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Param<wbr/>List</span></a>
<a href="TinyYolov2.html#getTrainableParams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Trainable<wbr/>Params</span></a>
<a href="TinyYolov2.html#load" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load</span></a>
<a href="TinyYolov2.html#loadFromDisk" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Disk</span></a>
<a href="TinyYolov2.html#loadFromUri" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Uri</span></a>
<a href="TinyYolov2.html#loadFromWeightMap" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Weight<wbr/>Map</span></a>
<a href="TinyYolov2.html#locateFaces" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>locate<wbr/>Faces</span></a>
<a href="TinyYolov2.html#reassignParamFromPath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reassign<wbr/>Param<wbr/>From<wbr/>Path</span></a>
<a href="TinyYolov2.html#runMobilenet" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Mobilenet</span></a>
<a href="TinyYolov2.html#runTinyYolov2" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Tiny<wbr/>Yolov2</span></a>
<a href="TinyYolov2.html#serializeParams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>serialize<wbr/>Params</span></a>
<a href="TinyYolov2.html#variable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>variable</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TinyYolov2" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Tiny<wbr/>Yolov2</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">withSeparableConvs</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TinyYolov2.html" class="tsd-signature-type tsd-kind-class">TinyYolov2</a><a href="#constructor.new_TinyYolov2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">withSeparableConvs</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TinyYolov2.html" class="tsd-signature-type tsd-kind-class">TinyYolov2</a></h4><aside class="tsd-sources"><p>Overrides TinyYolov2Base.constructor</p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/tinyYolov2/TinyYolov2.ts#L19">src/tinyYolov2/TinyYolov2.ts:19</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>_name</span><a href="#_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from TinyYolov2Base._name</p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/NeuralNetwork.ts#L17">src/NeuralNetwork.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="DEFAULT_FILTER_SIZES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>DEFAULT_<wbr/>FILTER_<wbr/>SIZES</span><a href="#DEFAULT_FILTER_SIZES" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>FILTER_<wbr/>SIZES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from TinyYolov2Base.DEFAULT_FILTER_SIZES</p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/tinyYolov2/TinyYolov2Base.ts#L25">src/tinyYolov2/TinyYolov2Base.ts:25</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="anchors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>anchors</span><a href="#anchors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="anchors.anchors-1"><span class="tsd-signature-keyword">get</span> anchors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-ty