<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Pooling — PaddlePaddle documentation</title> <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> <link rel="index" title="Index" href="../../../genindex.html"/> <link rel="search" title="Search" href="../../../search.html"/> <link rel="top" title="PaddlePaddle documentation" href="../../../index.html"/> <link rel="up" title="Model Configuration" href="../model_configs.html"/> <link rel="next" title="Networks" href="networks.html"/> <link rel="prev" title="Optimizer" href="optimizer.html"/> <link rel="stylesheet" href="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/css/perfect-scrollbar.min.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/css/override.css" type="text/css" /> <script> var _hmt = _hmt || []; (function() { var hm = document.createElement("script"); hm.src = "//hm.baidu.com/hm.js?b9a314ab40d04d805655aab1deee08ba"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s); })(); </script> <script src="../../../_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <header class="site-header"> <div class="site-logo"> <a href="/"><img src="../../../_static/images/PP_w.png"></a> </div> <div class="site-nav-links"> <div class="site-menu"> <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Folk me on Github</a> <div class="language-switcher dropdown"> <a type="button" data-toggle="dropdown"> <span>English</span> <i class="fa fa-angle-up"></i> <i class="fa fa-angle-down"></i> </a> <ul class="dropdown-menu"> <li><a href="/doc_cn">中文</a></li> <li><a href="/doc">English</a></li> </ul> </div> <ul class="site-page-links"> <li><a href="/">Home</a></li> </ul> </div> <div class="doc-module"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../howto/index_en.html">HOW TO</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../../index_en.html">API</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../about/index_en.html">ABOUT</a></li> </ul> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> </div> </header> <div class="main-content-wrap"> <nav class="doc-menu-vertical" role="navigation"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../../getstarted/build_and_install/index_en.html">Install and Build</a><ul> <li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/docker_install_en.html">PaddlePaddle in Docker Containers</a></li> <li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/ubuntu_install_en.html">Debian Package installation guide</a></li> <li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/build_from_source_en.html">Installing from Sources</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../../howto/index_en.html">HOW TO</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cmd_parameter/index_en.html">Set Command-line Parameters</a><ul> <li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/use_case_en.html">Use Case</a></li> <li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/arguments_en.html">Argument Outline</a></li> <li class="toctree-l3"><a class="reference internal" href="../../../howto/usage/cmd_parameter/detail_introduction_en.html">Detail Description</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/cluster/cluster_train_en.html">Run Distributed Training</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/k8s/k8s_en.html">Paddle On Kubernetes</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/usage/k8s/k8s_aws_en.html">Distributed PaddlePaddle Training on AWS with Kubernetes</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/dev/new_layer_en.html">Write New Layers</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/dev/contribute_to_paddle_en.html">Contribute Code</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/deep_model/rnn/index_en.html">RNN Models</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../howto/optimization/gpu_profiling_en.html">Tune GPU Performance</a></li> </ul> </li> <li class="toctree-l1 current"><a class="reference internal" href="../../index_en.html">API</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="../model_configs.html">Model Configuration</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="activation.html">Activation</a></li> <li class="toctree-l3"><a class="reference internal" href="layer.html">Layers</a></li> <li class="toctree-l3"><a class="reference internal" href="evaluators.html">Evaluators</a></li> <li class="toctree-l3"><a class="reference internal" href="optimizer.html">Optimizer</a></li> <li class="toctree-l3 current"><a class="current reference internal" href="#">Pooling</a></li> <li class="toctree-l3"><a class="reference internal" href="networks.html">Networks</a></li> <li class="toctree-l3"><a class="reference internal" href="attr.html">Parameter Attribute</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../data.html">Data Reader Interface and DataSets</a></li> <li class="toctree-l2"><a class="reference internal" href="../run_logic.html">Training and Inference</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../../about/index_en.html">ABOUT</a></li> </ul> </nav> <section class="doc-content-wrap"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="../../index_en.html">API</a> > </li> <li><a href="../model_configs.html">Model Configuration</a> > </li> <li>Pooling</li> </ul> </div> <div class="wy-nav-content" id="doc-content"> <div class="rst-content"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="pooling"> <h1>Pooling<a class="headerlink" href="#pooling" title="Permalink to this headline">¶</a></h1> <div class="section" id="basepool"> <h2>BasePool<a class="headerlink" href="#basepool" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">BasePool</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span></dt> <dd><p>Base Pooling Type. Note these pooling types are used for sequence input, not for images. Each PoolingType contains one parameter:</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>basestring</em>) – pooling layer type name used by paddle.</td> </tr> </tbody> </table> </dd></dl> </div> <div class="section" id="avg"> <h2>Avg<a class="headerlink" href="#avg" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">Avg</code><span class="sig-paren">(</span><em>strategy='average'</em><span class="sig-paren">)</span></dt> <dd><p>Average pooling.</p> <p>Return the average values for each dimension in sequence or time steps.</p> <div class="math"> \[sum(samples\_of\_a\_sequence)/sample\_num\]</div> </dd></dl> </div> <div class="section" id="max"> <h2>Max<a class="headerlink" href="#max" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">Max</code><span class="sig-paren">(</span><em>output_max_index=None</em><span class="sig-paren">)</span></dt> <dd><p>Max pooling.</p> <p>Return the very large values for each dimension in sequence or time steps.</p> <div class="math"> \[max(samples\_of\_a\_sequence)\]</div> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>output_max_index</strong> (<em>bool|None</em>) – True if output sequence max index instead of max value. None means use default value in proto.</td> </tr> </tbody> </table> </dd></dl> </div> <div class="section" id="sum"> <h2>Sum<a class="headerlink" href="#sum" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">Sum</code></dt> <dd><p>Sum pooling.</p> <p>Return the sum values of each dimension in sequence or time steps.</p> <div class="math"> \[sum(samples\_of\_a\_sequence)\]</div> </dd></dl> </div> <div class="section" id="squarerootn"> <h2>SquareRootN<a class="headerlink" href="#squarerootn" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">SquareRootN</code></dt> <dd><p>Square Root Pooling.</p> <p>Return the square root values of each dimension in sequence or time steps.</p> <div class="math"> \[sum(samples\_of\_a\_sequence)/sqrt(sample\_num)\]</div> </dd></dl> </div> <div class="section" id="cudnnavg"> <h2>CudnnAvg<a class="headerlink" href="#cudnnavg" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">CudnnAvg</code></dt> <dd><p>Cudnn average pooling only support GPU. Return the average value in the pooling window.</p> </dd></dl> </div> <div class="section" id="cudnnmax"> <h2>CudnnMax<a class="headerlink" href="#cudnnmax" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt> <em class="property">class </em><code class="descclassname">paddle.v2.pooling.</code><code class="descname">CudnnMax</code></dt> <dd><p>Cudnn max pooling only support GPU. Return the maxinum value in the pooling window.</p> </dd></dl> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="networks.html" class="btn btn-neutral float-right" title="Networks" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="optimizer.html" class="btn btn-neutral" title="Optimizer" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2016, PaddlePaddle developers. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: ".txt", }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> <script type="text/javascript" src="../../../_static/underscore.js"></script> <script type="text/javascript" src="../../../_static/doctools.js"></script> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> <script type="text/javascript" src="../../../_static/js/theme.js"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/js/perfect-scrollbar.jquery.min.js"></script> <script src="../../../_static/js/paddle_doc_init.js"></script> </body> </html>