Deploy to GitHub Pages: 9cfa5ce3

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

@@ -1225,8 +1225,61 @@ the BatchNorm layer using the configurations from the input parameters.</p>
 <dl class="function">
 <dt>
 <code class="descclassname">paddle.v2.fluid.layers.</code><code class="descname">lod_rank_table</code><span class="sig-paren">(</span><em>x</em>, <em>level=0</em><span class="sig-paren">)</span></dt>
-<dd><p>This function creates an operator for creating a LOD_RANK_TABLE
-using the input x.</p>
+<dd><p>LoD Rank Table Operator. Given an input variable <strong>x</strong> and a level number
+of LoD, this layer creates a LodRankTable object. A LoDRankTable object
+contains a list of bi-element tuples. Each tuple consists of an index and
+a length, both of which are int type. Reffering to specified level of LoD,
+the index is the sequence index number and the length representes the
+sequence length. Please note that the list is ranked in descending order by
+the length. The following is an example:</p>
+<blockquote>
+<div><div class="highlight-text"><div class="highlight"><pre><span></span>x is a LoDTensor:
+    x.lod = [[0,                2, 3],
+             [0,             5, 6, 7]]
+    x.data = [a, b, c, d, e, f, g]
+
+1. set level to 0:
+    Create lod rank table:
+        lod_rank_table_obj = lod_rank_table(x, level=0)
+
+    Get:
+        lod_rank_table_obj.items() = [(0, 2), (1, 1)]
+
+2. set level to 1:
+    Create lod rank table:
+        lod_rank_table_obj = lod_rank_table(x, level=1)
+
+    Get:
+        lod_rank_table_obj.items() = [(0, 5), (1, 1), (2, 1)]
+</pre></div>
+</div>
+</div></blockquote>
+<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>x</strong> (<em>Variable</em>) &#8211; Input variable, a LoDTensor based which to create the lod
+rank table.</li>
+<li><strong>level</strong> (<em>int</em>) &#8211; Specify the LoD level, on which to create the lod rank
+table.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The created LoDRankTable object.</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">dtype</span><span class="o">=</span><span class="s1">&#39;float32&#39;</span><span class="p">,</span> <span class="n">lod_level</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">out</span> <span class="o">=</span> <span class="n">layers</span><span class="o">.</span><span class="n">lod_rank_table</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
+</pre></div>
+</div>
 </dd></dl>
 
 </div>

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

@@ -1238,8 +1238,61 @@ the BatchNorm layer using the configurations from the input parameters.</p>
 <dl class="function">
 <dt>
 <code class="descclassname">paddle.v2.fluid.layers.</code><code class="descname">lod_rank_table</code><span class="sig-paren">(</span><em>x</em>, <em>level=0</em><span class="sig-paren">)</span></dt>
-<dd><p>This function creates an operator for creating a LOD_RANK_TABLE
-using the input x.</p>
+<dd><p>LoD Rank Table Operator. Given an input variable <strong>x</strong> and a level number
+of LoD, this layer creates a LodRankTable object. A LoDRankTable object
+contains a list of bi-element tuples. Each tuple consists of an index and
+a length, both of which are int type. Reffering to specified level of LoD,
+the index is the sequence index number and the length representes the
+sequence length. Please note that the list is ranked in descending order by
+the length. The following is an example:</p>
+<blockquote>
+<div><div class="highlight-text"><div class="highlight"><pre><span></span>x is a LoDTensor:
+    x.lod = [[0,                2, 3],
+             [0,             5, 6, 7]]
+    x.data = [a, b, c, d, e, f, g]
+
+1. set level to 0:
+    Create lod rank table:
+        lod_rank_table_obj = lod_rank_table(x, level=0)
+
+    Get:
+        lod_rank_table_obj.items() = [(0, 2), (1, 1)]
+
+2. set level to 1:
+    Create lod rank table:
+        lod_rank_table_obj = lod_rank_table(x, level=1)
+
+    Get:
+        lod_rank_table_obj.items() = [(0, 5), (1, 1), (2, 1)]
+</pre></div>
+</div>
+</div></blockquote>
+<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>x</strong> (<em>Variable</em>) &#8211; Input variable, a LoDTensor based which to create the lod
+rank table.</li>
+<li><strong>level</strong> (<em>int</em>) &#8211; Specify the LoD level, on which to create the lod rank
+table.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">返回:</th><td class="field-body"><p class="first">The created LoDRankTable object.</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">dtype</span><span class="o">=</span><span class="s1">&#39;float32&#39;</span><span class="p">,</span> <span class="n">lod_level</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">out</span> <span class="o">=</span> <span class="n">layers</span><span class="o">.</span><span class="n">lod_rank_table</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
+</pre></div>
+</div>
 </dd></dl>
 
 </div>