From 05c7b3786b3dde9d2c90e20ad799cf35490c5711 Mon Sep 17 00:00:00 2001 From: guofei <52460041+gfwm2013@users.noreply.github.com> Date: Thu, 26 Sep 2019 23:53:08 +0800 Subject: [PATCH] Refine the document of data_cn.rst (#1370) --- doc/fluid/api_cn/layers_cn/data_cn.rst | 28 +++++++++++++------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/fluid/api_cn/layers_cn/data_cn.rst b/doc/fluid/api_cn/layers_cn/data_cn.rst index 3428aeab2..9b9f7a757 100644 --- a/doc/fluid/api_cn/layers_cn/data_cn.rst +++ b/doc/fluid/api_cn/layers_cn/data_cn.rst @@ -5,33 +5,33 @@ data .. py:function:: paddle.fluid.layers.data(name, shape, append_batch_size=True, dtype='float32', lod_level=0, type=VarType.LOD_TENSOR, stop_gradient=True) -数据层(Data Layer) +该OP会在全局block中创建变量（Variable），该全局变量可被计算图中的算子（operator）访问。 -该功能接受输入数据，判断是否需要以minibatch方式返回数据，然后使用辅助函数创建全局变量。该全局变量可由计算图中的所有operator访问。 +注意： -这个函数的所有输入变量都作为本地变量传递给LayerHelper构造函数。 + 不推荐使用 ``paddle.fluid.layers.data`` ，因其在之后的版本中会被删除。请使用 ``paddle.fluid.data`` 。 -请注意，paddle在编译期间仅使用shape来推断网络中以下变量的形状。在运行期间，paddle不会检查所需数据的形状是否与此函数中的形状设置相匹配。 + ``paddle.fluid.layers.data`` 在组网期间会设置创建的变量维度（shape）和数据类型（dtype），但不会检查输入数据的维度和数据类型是否符合要求。 ``paddle.fluid.data`` 会在运行过程中由Executor/ParallelExecutor检查输入数据的维度。 参数： - - **name** (str)-函数名或函数别名 - - **shape** (list)-声明维度信息的list。如果 ``append_batch_size`` 为True且内部没有维度值为-1，则应将其视为每个样本的形状。 否则，应将其视为batch数据的形状。 + - **name** (str)- 被创建的变量的名字，具体用法请参见 :ref:`api_guide_Name` 。 + - **shape** (list)- 声明维度信息的list。如果 ``append_batch_size`` 为True且内部没有维度值为-1，则应将其视为每个样本的形状。 否则，应将其视为batch数据的形状。 - **append_batch_size** (bool)- - 1.如果为真，则在维度shape的开头插入-1。 - 例如，如果shape=[1],则输出shape为[-1,1]。这对在运行期间设置不同的batch大小很有用。 + 1.如果为True，则在维度（shape）的开头插入-1。 + 例如，如果shape=[1],则输出shape为[-1,1]。可用于设置运行期间不同batch大小。 - 2.如果维度shape包含-1，比如shape=[-1,1]。 + 2.如果维度（shape）包含-1，比如shape=[-1,1]。 append_batch_size会强制变为为False（表示无效），因为PaddlePaddle不能在shape上设置一个以上的未知数。 - - **dtype** (np.dtype|VarType|str)-数据类型：float32,float_16,int等 - - **type** (VarType)-输出类型。默认为LOD_TENSOR - - **lod_level** (int)-LoD层。0表示输入数据不是一个序列 - - **stop_gradient** (bool)-布尔类型，提示是否应该停止计算梯度 + - **dtype** (np.dtype|VarType|str)- 数据类型，支持bool，float16，float32，float64，int8，int16，int32，int64，uint8。 + - **type** (VarType)- 输出类型，支持VarType.LOD_TENSOR，VarType.SELECTED_ROWS，VarType.NCCL_ID。默认为VarType.LOD_TENSOR。 + - **lod_level** (int)- LoD层。0表示输入数据不是一个序列。默认值为0。 + - **stop_gradient** (bool)- 提示是否应该停止计算梯度，默认值为True。 返回：全局变量，可进行数据访问 -返回类型：变量(Variable) +返回类型：Variable **代码示例**： -- GitLab