Deploy to GitHub Pages: f3812825

develop/doc/api/v2/fluid/layers.html

@@ -1320,7 +1320,43 @@ operator just returns the sequence length of the first tuple element.</p>
 <dl class="function">
 <dt>
 <code class="descclassname">paddle.v2.fluid.layers.</code><code class="descname">topk</code><span class="sig-paren">(</span><em>input</em>, <em>k</em><span class="sig-paren">)</span></dt>
-<dd></dd></dl>
+<dd><p><strong>topk</strong></p>
+<p>This function performs the operation that selects the k entries in the input
+vector and outputs their values and indices as vectors. Thus topk_out[j] is
+the j-th largest entry in input, and its index is topk_indices[j]</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"><ul class="first simple">
+<li><strong>input</strong> (<em>Variable|list</em>) &#8211; The input tensor that has all the data.</li>
+<li><strong>k</strong> (<em>int</em>) &#8211; The number of top elements that the function will pick.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
+<dt>The variable of type array that contains the k largest entries</dt>
+<dd><p class="first last">from input.</p>
+</dd>
+<dt>Variable: The variable of type array that contains the indices of k</dt>
+<dd><p class="first last">largest entries from input.</p>
+</dd>
+</dl>
+</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Variable</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">x</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;x&#39;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">[</span><span class="mi">10</span><span class="p">])</span>
+<span class="n">k</span> <span class="o">=</span> <span class="mi">5</span>
+<span class="n">array</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">topk</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
+</pre></div>
+</div>
+</dd></dl>
 
 </div>
 <div class="section" id="lod-tensor-to-array">

develop/doc_cn/api/v2/fluid/layers.html

@@ -1333,7 +1333,43 @@ operator just returns the sequence length of the first tuple element.</p>
 <dl class="function">
 <dt>
 <code class="descclassname">paddle.v2.fluid.layers.</code><code class="descname">topk</code><span class="sig-paren">(</span><em>input</em>, <em>k</em><span class="sig-paren">)</span></dt>
-<dd></dd></dl>
+<dd><p><strong>topk</strong></p>
+<p>This function performs the operation that selects the k entries in the input
+vector and outputs their values and indices as vectors. Thus topk_out[j] is
+the j-th largest entry in input, and its index is topk_indices[j]</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">参数:</th><td class="field-body"><ul class="first simple">
+<li><strong>input</strong> (<em>Variable|list</em>) &#8211; The input tensor that has all the data.</li>
+<li><strong>k</strong> (<em>int</em>) &#8211; The number of top elements that the function will pick.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">返回:</th><td class="field-body"><p class="first"><dl class="docutils">
+<dt>The variable of type array that contains the k largest entries</dt>
+<dd><p class="first last">from input.</p>
+</dd>
+<dt>Variable: The variable of type array that contains the indices of k</dt>
+<dd><p class="first last">largest entries from input.</p>
+</dd>
+</dl>
+</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">返回类型:</th><td class="field-body"><p class="first last">Variable</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">x</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;x&#39;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">[</span><span class="mi">10</span><span class="p">])</span>
+<span class="n">k</span> <span class="o">=</span> <span class="mi">5</span>
+<span class="n">array</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">topk</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
+</pre></div>
+</div>
+</dd></dl>
 
 </div>
 <div class="section" id="lod-tensor-to-array">