face-api/typedoc/functions/tf.separableConv2d.html

29 lines
13 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>separableConv2d | @vladmandic/face-api - v1.7.14</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/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><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="../assets/icons.svg#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.14</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="../assets/icons.svg#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="../modules/tf.html">tf</a></li><li><a href="tf.separableConv2d.html">separableConv2d</a></li></ul><h1>Function separableConv2d</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="separableconv2d" class="tsd-anchor"></a><span class="tsd-kind-call-signature">separableConv2d</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="tf.separableConv2d.html#separableconv2dt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.Tensor3D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor3D</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="tf.separableConv2d.html#separableconv2dt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">depthwiseFilter</span><span class="tsd-signature-symbol">:</span> <a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">pointwiseFilter</span><span class="tsd-signature-symbol">:</span> <a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">strides</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><span class="tsd-signature-type">number</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><br/>    <span class="tsd-kind-parameter">pad</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;valid&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;same&quot;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">dilation</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><span class="tsd-signature-type">number</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><br/>    <span class="tsd-kind-parameter">dataFormat</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;NHWC&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;NCHW&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="tf.separableConv2d.html#separableconv2dt">T</a><a href="#separableconv2d" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>2-D convolution with separable filters.</p>
<p>Performs a depthwise convolution that acts separately on channels followed
by a pointwise convolution that mixes channels. Note that this is
separability between dimensions [1, 2] and 3, not spatial separability
between dimensions 1 and 2.</p>
<p>See
<a href="https://www.tensorflow.org/api_docs/python/tf/nn/separable_conv2d">https://www.tensorflow.org/api_docs/python/tf/nn/separable_conv2d</a>
for more details.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="separableconv2dt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.Tensor3D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor3D</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="tf.separableConv2d.html#separableconv2dt">T</a></span><div class="tsd-comment tsd-typography"><p>The input tensor, of rank 4 or rank 3, of shape
<code>[batch, height, width, inChannels]</code>. If rank 3, batch of 1 is
assumed.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">depthwiseFilter</span>: <a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a></span><div class="tsd-comment tsd-typography"><p>The depthwise filter tensor, rank 4, of shape
<code>[filterHeight, filterWidth, inChannels, channelMultiplier]</code>. This is
the filter used in the first step.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pointwiseFilter</span>: <a href="../types/tf.Tensor4D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor4D</a> <span class="tsd-signature-symbol">|</span> <a href="../types/tf.TensorLike.html" class="tsd-signature-type tsd-kind-type-alias">TensorLike</a></span><div class="tsd-comment tsd-typography"><p>The pointwise filter tensor, rank 4, of shape
<code>[1, 1, inChannels * channelMultiplier, outChannels]</code>. This is
the filter used in the second step.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">strides</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>The strides of the convolution: <code>[strideHeight, strideWidth]</code>. If strides is a single number, then <code>strideHeight == strideWidth</code>.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pad</span>: <span class="tsd-signature-type">&quot;valid&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;same&quot;</span></span><div class="tsd-comment tsd-typography"><p>The type of padding algorithm.</p>
<ul>
<li><code>same</code> and stride 1: output will be of same size as input,
regardless of filter size.</li>
<li><code>valid</code>: output will be smaller than input if filter is larger
than 1x1.</li>
<li>For more info, see this guide:
<a href="https://www.tensorflow.org/api_docs/python/tf/nn/convolution">https://www.tensorflow.org/api_docs/python/tf/nn/convolution</a></li>
</ul>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">dilation</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">dataFormat</span>: <span class="tsd-signature-type">&quot;NHWC&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;NCHW&quot;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="tf.separableConv2d.html#separableconv2dt">T</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-doc"><h4 class="tsd-anchor-link"><a id="doc" class="tsd-anchor"></a>Doc<a href="#doc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/@tensorflow+tfjs-core@4.22.0/node_modules/@tensorflow/tfjs-core/dist/ops/separable_conv2d.d.ts:66</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@vladmandic/face-api - v1.7.14</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>