提交 8e19c324 编写于 作者: Q qiaolongfei

update split_lod_tensor, create_array and array_length doc

上级 19fd0717
...@@ -62,6 +62,8 @@ def split_lod_tensor(input, mask, level=0): ...@@ -62,6 +62,8 @@ def split_lod_tensor(input, mask, level=0):
The output is the true branch and the false branch with the mask applied to The output is the true branch and the false branch with the mask applied to
the input at a certain level in the tensor. the input at a certain level in the tensor.
Mainly used in IfElse to split data into two parts. Related API: IfElse.
Args: Args:
input(tuple|list|None): The input tensor that contains complete input(tuple|list|None): The input tensor that contains complete
lod information needed to construct the output. lod information needed to construct the output.
...@@ -83,6 +85,7 @@ def split_lod_tensor(input, mask, level=0): ...@@ -83,6 +85,7 @@ def split_lod_tensor(input, mask, level=0):
out_true, out_false = layers.split_lod_tensor( out_true, out_false = layers.split_lod_tensor(
input=x, mask=y, level=level) input=x, mask=y, level=level)
""" """
helper = LayerHelper('split_lod_tensor', **locals()) helper = LayerHelper('split_lod_tensor', **locals())
out_true = helper.create_tmp_variable(dtype=input.dtype) out_true = helper.create_tmp_variable(dtype=input.dtype)
...@@ -887,14 +890,18 @@ def array_write(x, i, array=None): ...@@ -887,14 +890,18 @@ def array_write(x, i, array=None):
def create_array(dtype): def create_array(dtype):
"""This function creates an array of type :math:`LOD_TENSOR_ARRAY` using the """
LayerHelper. **Create LoDTensor Array**
This function creates an array of type :math:`LOD_TENSOR_ARRAY` using the
LayerHelper. It is mainly used to implement RNN with array_write, array_read
and While.
Args: Args:
dtype (int|float): The data type of the elements in the array. dtype (int|float): The data type of the elements in the array.
Returns: Returns:
Variable: The tensor variable storing the elements of data type. Variable: The lod_tensor_array variable storing the elements of data type.
Examples: Examples:
.. code-block:: python .. code-block:: python
...@@ -1020,9 +1027,14 @@ def shrink_memory(x, i, table): ...@@ -1020,9 +1027,14 @@ def shrink_memory(x, i, table):
def array_length(array): def array_length(array):
"""This function performs the operation to find the length of the input """
**Get the length of Input LoDTensorArray**
This function performs the operation to find the length of the input
LOD_TENSOR_ARRAY. LOD_TENSOR_ARRAY.
Related API: array_read, array_write, While.
Args: Args:
array (LOD_TENSOR_ARRAY): The input array that will be used array (LOD_TENSOR_ARRAY): The input array that will be used
to compute the length. to compute the length.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册