poolings.html 9.0 KB
Newer Older
Y
Yu Yang 已提交
1 2 3 4 5 6 7 8
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
9
    <title>BasePoolingType &#8212; PaddlePaddle  documentation</title>
Y
Yu Yang 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
    
    <link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../',
        VERSION:     '',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="top" title="PaddlePaddle  documentation" href="../../../index.html" />
Y
Yu Yang 已提交
28 29 30
    <link rel="up" title="Poolings" href="poolings_index.html" />
    <link rel="next" title="Networks" href="networks_index.html" />
    <link rel="prev" title="Poolings" href="poolings_index.html" /> 
Y
Yu Yang 已提交
31 32 33 34 35 36 37 38 39 40 41 42
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
43
          <a href="networks_index.html" title="Networks"
Y
Yu Yang 已提交
44 45
             accesskey="N">next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
46
          <a href="poolings_index.html" title="Poolings"
Y
Yu Yang 已提交
47
             accesskey="P">previous</a> |</li>
48 49 50 51
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Model Config Interface</a> &#187;</li>
          <li class="nav-item nav-item-3"><a href="poolings_index.html" accesskey="U">Poolings</a> &#187;</li> 
Y
Yu Yang 已提交
52 53 54 55 56 57 58 59
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
Y
Yu Yang 已提交
60 61
  <div class="section" id="basepoolingtype">
<h1>BasePoolingType<a class="headerlink" href="#basepoolingtype" title="Permalink to this headline"></a></h1>
Y
Yu Yang 已提交
62
<dl class="class">
Y
Yu Yang 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75
<dt>
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.poolings.</code><code class="descname">BasePoolingType</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>) &#8211; pooling layer type name used by paddle.</td>
</tr>
</tbody>
</table>
Y
Yu Yang 已提交
76 77
</dd></dl>

Y
Yu Yang 已提交
78 79 80
</div>
<div class="section" id="avgpooling">
<h1>AvgPooling<a class="headerlink" href="#avgpooling" title="Permalink to this headline"></a></h1>
Y
Yu Yang 已提交
81
<dl class="class">
Y
Yu Yang 已提交
82 83 84 85
<dt>
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.poolings.</code><code class="descname">AvgPooling</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>
Y
Yu Yang 已提交
86
<div class="math">
Y
Yu Yang 已提交
87
\[sum(samples\_of\_a\_sequence)/sample\_num\]</div>
Y
Yu Yang 已提交
88 89
</dd></dl>

Y
Yu Yang 已提交
90 91 92
</div>
<div class="section" id="maxpooling">
<h1>MaxPooling<a class="headerlink" href="#maxpooling" title="Permalink to this headline"></a></h1>
Y
Yu Yang 已提交
93
<dl class="class">
Y
Yu Yang 已提交
94
<dt>
95
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.poolings.</code><code class="descname">MaxPooling</code><span class="sig-paren">(</span><em>output_max_index=None</em><span class="sig-paren">)</span></dt>
Y
Yu Yang 已提交
96 97
<dd><p>Max pooling.</p>
<p>Return the very large values for each dimension in sequence or time steps.</p>
Y
Yu Yang 已提交
98
<div class="math">
Y
Yu Yang 已提交
99
\[max(samples\_of\_a\_sequence)\]</div>
100 101 102 103 104 105 106 107 108
<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>) &#8211; True if output sequence max index instead of max
value. None means use default value in proto.</td>
</tr>
</tbody>
</table>
Y
Yu Yang 已提交
109 110
</dd></dl>

Y
Yu Yang 已提交
111 112 113
</div>
<div class="section" id="sumpooling">
<h1>SumPooling<a class="headerlink" href="#sumpooling" title="Permalink to this headline"></a></h1>
Y
Yu Yang 已提交
114
<dl class="class">
Y
Yu Yang 已提交
115 116
<dt>
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.poolings.</code><code class="descname">SumPooling</code></dt>
Y
Yu Yang 已提交
117 118 119 120 121 122
<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>

Y
Yu Yang 已提交
123 124 125
</div>
<div class="section" id="squarerootnpooling">
<h1>SquareRootNPooling<a class="headerlink" href="#squarerootnpooling" title="Permalink to this headline"></a></h1>
Y
Yu Yang 已提交
126
<dl class="class">
Y
Yu Yang 已提交
127 128
<dt>
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.poolings.</code><code class="descname">SquareRootNPooling</code></dt>
Y
Yu Yang 已提交
129 130 131 132 133 134 135 136 137 138 139 140 141 142
<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>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
Y
Yu Yang 已提交
143 144 145 146 147 148 149 150 151
  <h3><a href="../../../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">BasePoolingType</a></li>
<li><a class="reference internal" href="#avgpooling">AvgPooling</a></li>
<li><a class="reference internal" href="#maxpooling">MaxPooling</a></li>
<li><a class="reference internal" href="#sumpooling">SumPooling</a></li>
<li><a class="reference internal" href="#squarerootnpooling">SquareRootNPooling</a></li>
</ul>

Y
Yu Yang 已提交
152
  <h4>Previous topic</h4>
Y
Yu Yang 已提交
153 154
  <p class="topless"><a href="poolings_index.html"
                        title="previous chapter">Poolings</a></p>
Y
Yu Yang 已提交
155
  <h4>Next topic</h4>
Y
Yu Yang 已提交
156
  <p class="topless"><a href="networks_index.html"
Y
Yu Yang 已提交
157 158 159 160 161 162 163 164 165 166 167
                        title="next chapter">Networks</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../../_sources/ui/api/trainer_config_helpers/poolings.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../../search.html" method="get">
168 169
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
Y
Yu Yang 已提交
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
189
          <a href="networks_index.html" title="Networks"
Y
Yu Yang 已提交
190 191
             >next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
192
          <a href="poolings_index.html" title="Poolings"
Y
Yu Yang 已提交
193
             >previous</a> |</li>
194 195 196 197
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Model Config Interface</a> &#187;</li>
          <li class="nav-item nav-item-3"><a href="poolings_index.html" >Poolings</a> &#187;</li> 
Y
Yu Yang 已提交
198 199 200
      </ul>
    </div>
    <div class="footer" role="contentinfo">
201 202
        &#169; Copyright 2016, PaddlePaddle developers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
Y
Yu Yang 已提交
203 204 205
    </div>
  </body>
</html>