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 > maxPool | @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 = "../modules/tf.html" > tf< / a > < / li > < li > < a href = "tf.maxPool.html" > maxPool< / a > < / li > < / ul > < h1 > Function maxPool< / h1 > < / div > < section class = "tsd-panel" > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "maxPool" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > max< wbr / > Pool< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "tf.maxPool.html#maxPool.T" > T< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > x< / span > , < span class = "tsd-kind-parameter" > filterSize< / span > , < span class = "tsd-kind-parameter" > strides< / span > , < span class = "tsd-kind-parameter" > pad< / span > , < span class = "tsd-kind-parameter" > dimRoundingMode< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "tf.maxPool.html#maxPool.T" > T< / a > < a href = "#maxPool" 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-comment tsd-typography" > < p > Computes the 2D max pooling of an image.< / p >
< / div > < section class = "tsd-panel" > < h4 > Type Parameters< / h4 > < ul class = "tsd-type-parameter-list" > < li > < h4 > < a id = "maxPool.T" 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 > < / h4 > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < 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.maxPool.html#maxPool.T" > T< / a > < / h5 > < 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 > < h5 > < span class = "tsd-kind-parameter" > filterSize< / 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 > < / h5 > < div class = "tsd-comment tsd-typography" > < p > The filter size: < code > [filterHeight, filterWidth]< / code > . If
< code > filterSize< / code > is a single number, then < code > filterHeight == filterWidth< / code > .< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < 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 > < / h5 > < div class = "tsd-comment tsd-typography" > < p > The strides of the pooling: < code > [strideHeight, strideWidth]< / code > . If
< code > strides< / code > is a single number, then < code > strideHeight == strideWidth< / code > .< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > pad< / span > : < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " valid" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " same" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > ExplicitPadding< / span > < / h5 > < 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 > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > dimRoundingMode< / span > : < span class = "tsd-signature-type" > " floor" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " round" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " ceil" < / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > A string from: ' ceil' , ' round' , ' floor' . If none is
provided, it will default to truncate.< / p >
2024-02-07 17:20:36 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a class = "tsd-signature-type tsd-kind-type-parameter" href = "tf.maxPool.html#maxPool.T" > T< / a > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@tensorflow/tfjs-core/dist/ops/max_pool.d.ts:47< / li > < / ul > < / aside > < / li > < / ul > < / section > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < h4 class = "uppercase" > Member Visibility< / h4 > < form > < 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 > < / form > < / div > < div class = "tsd-theme-toggle" > < h4 class = "uppercase" > Theme< / h4 > < 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" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1" > < / use > < / svg > < span > @vladmandic/face-api - v1.7.13< / span > < / a > < ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" data-base = ".." > < li > < a href = "../modules/draw.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-4" > < / use > < / svg > draw< / a > < / li > < li > < a href = "../modules/tf.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-4" > < / use > < / svg > tf< / a > < / li > < li > < a href = "../modules/utils.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-4" > < / use > < / svg > utils< / a > < / li > < li > < a href = "../enums/Gender.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-8" > < / use > < / svg > Gender< / a > < / li > < li > < a href = "../classes/AgeGenderNet.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > AgeGenderNet< / a > < / li > < li > < a href = "../classes/BoundingBox.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > BoundingBox< / a > < / li > < li > < a href = "../classes/Box.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > Box< / a > < / li > < li > < a href = "../classes/ComposableTask.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > ComposableTask< / a > < / li > < li > < a href = "../classes/ComputeAllFaceDescriptorsTask.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > ComputeAllFaceDescriptorsTask< / a > < / li > < li > < a href = "../classes/ComputeFaceDescriptorsTaskBase.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > ComputeFaceDescriptorsTaskBase< / a > < / li > < li > < a href = "../classes/ComputeSingleFaceDescriptorTask.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > ComputeSingleFaceDescriptorTask< / a > < / li > < li > < a href = "../classes/DetectAllFaceLandmarksTask.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > DetectAllFaceLandmarksTask< / a > < / li > < li > < a href = "../classes/DetectAllFacesTask.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > DetectAllFacesTask< / a > < / li > < li > < a href = "../classes/DetectFaceLandmarksTaskBase.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-128" > < / use > < / svg > DetectFaceLandmarksTaskBase< / a > < / li > < li > < a href = "../classes/DetectFacesTaskBase.html" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#
