未验证 提交 5a2d1f0f 编写于 作者: W wangchaochaohu 提交者: GitHub

reduce OP doc refine (#1282)

* fix the reduce api test=develop

* fix typo test=develop

* fix according reviewer advice test=develop
上级 db03a1fc
......@@ -5,15 +5,15 @@ reduce_max
.. py:function:: paddle.fluid.layers.reduce_max(input, dim=None, keep_dim=False, name=None)
计算给定维度上张量(Tensor)元素最大值
该OP是对指定维度上的Tensor元素求最大值运算,并输出相应的计算结果
参数:
- **input** (Variable):输入变量为Tensor或LoDTensor
- **dim** (list | int | None):函数运算的维度。如果为None,则计算所有元素中的最大值并返回单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input))` 范围内。如果 :math:`dim [i] <0` ,则维度将减小为 :math:`rank+dim[i]`
- **keep_dim** (bool | False):是否在输出Tensor中保留减小的维度。除非 ``keep_dim`` 为true,否则结果张量将比输入少一个维度
- **name** (str | None):这一层的名称(可选)。如果设置为None,则将自动命名这一层
- **input** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64,int32,int64
- **dim** (list | int ,可选)- 求最大值运算的维度。如果为None,则计算所有元素的最大值并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None
- **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** (str , 可选)- 这一层的名称。如果设置为None,则将自动命名这一层。默认值为None
返回: 运算、减少维度之后的Tensor变量
返回: 在指定dim上进行求最大值运算的Tensor,数据类型和输入数据类型一致
返回类型: 变量(Variable)
......@@ -26,7 +26,7 @@ reduce_max
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# 接下来的示例中,我们在每处函数调用后面都标注出了它的结果张量。
x = fluid.layers.data(name='x', shape=[4, 2], dtype='float32')
x = fluid.layers.data(name='x', shape=[2, 4], dtype='float32')
fluid.layers.reduce_max(x) # [0.9]
fluid.layers.reduce_max(x, dim=0) # [0.2, 0.3, 0.6, 0.9]
fluid.layers.reduce_max(x, dim=-1) # [0.9, 0.7]
......
......@@ -5,15 +5,15 @@ reduce_mean
.. py:function:: paddle.fluid.layers.reduce_mean(input, dim=None, keep_dim=False, name=None)
计算给定维度上张量(Tensor)元素平均值
该OP是对指定维度上的Tensor元素进行平均值算,并输出相应的计算结果
参数:
- **input** (Variable):输入变量为Tensor或LoDTensor
- **dim** (list | int | None):函数运算的维度。如果为None,则对输入的所有元素求平均值并返回单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input))` 范围内。如果 :math:`dim [i] <0` ,则维度将减小为 :math:`rank+dim[i]`
- **keep_dim** (bool | False):是否在输出Tensor中保留减小的维度。除非 ``keep_dim`` 为true,否则结果张量将比输入少一个维度
- **name** (str | None):这一层的名称(可选)。如果设置为None,则将自动命名这一层
- **input** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64,int32,int64
- **dim** (list | int ,可选)— 求平均值运算的维度。如果为None,则计算所有元素的平均值并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None
- **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** (str , 可选)— 这一层的名称。如果设置为None,则将自动命名这一层。默认值为None
返回: 运算、减少维度之后的Tensor变量
返回: 在指定dim上进行平均值运算的Tensor,数据类型和输入数据类型一致
返回类型: 变量(Variable)
......@@ -26,7 +26,7 @@ reduce_mean
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# 接下来的示例中,我们在每处函数调用后面都标注出了它的结果张量。
x = fluid.layers.data(name='x', shape=[4, 2], dtype='float32')
x = fluid.layers.data(name='x', shape=[2, 4], dtype='float32')
fluid.layers.reduce_mean(x) # [0.4375]
fluid.layers.reduce_mean(x, dim=0) # [0.15, 0.25, 0.55, 0.8]
fluid.layers.reduce_mean(x, dim=-1) # [0.475, 0.4]
......
......@@ -5,15 +5,15 @@ reduce_min
.. py:function:: paddle.fluid.layers.reduce_min(input, dim=None, keep_dim=False, name=None)
计算给定维度上张量元素的最小值
该OP是对指定维度上的Tensor元素求最小值运算,并输出相应的计算结果
参数:
- **input** (Variable):输入变量为Tensor或LoDTensor
- **dim** (list | int | None):函数运算的维度。如果为None,则对输入的所有元素求最小值并返回单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input))` 范围内。如果 :math:`dim [i] <0` ,则维度将减小为 :math:`rank+dim[i]`
- **keep_dim** (bool | False):是否在输出Tensor中保留减小的维度。除非 ``keep_dim`` 为true,否则结果张量将比输入少一个维度
- **name** (str | None):这一层的名称(可选)。如果设置为None,则将自动命名这一层
- **input** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64,int32,int64
- **dim** (list | int ,可选)- 求最小值运算的维度。如果为None,则计算所有元素的最小值并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None
- **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** (str , 可选)- 这一层的名称。如果设置为None,则将自动命名这一层。默认值为None
返回: 运算、减少维度之后的Tensor变量
返回: 在指定dim上进行求最小值运算的Tensor,数据类型和输入数据类型一致
返回类型: 变量(Variable)
......@@ -26,7 +26,7 @@ reduce_min
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# 接下来的示例中,我们在每处函数调用后面都标注出了它的结果张量。
x = fluid.layers.data(name='x', shape=[4, 2], dtype='float32')
x = fluid.layers.data(name='x', shape=[2, 4], dtype='float32')
fluid.layers.reduce_min(x) # [0.1]
fluid.layers.reduce_min(x, dim=0) # [0.1, 0.2, 0.5, 0.7]
fluid.layers.reduce_min(x, dim=-1) # [0.2, 0.1]
......
......@@ -5,15 +5,15 @@ reduce_prod
.. py:function:: paddle.fluid.layers.reduce_prod(input, dim=None, keep_dim=False, name=None)
计算给定维度上张量(Tensor)元素乘积
该OP是对指定维度上的Tensor元素进行求乘积运算,并输出相应的计算结果
参数:
- **input** (Variable):输入变量为Tensor或LoDTensor
- **dim** (list | int | None):函数运算的维度。如果为None,则将输入的所有元素相乘并返回单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input))` 范围内。如果 :math:`dim [i] <0` ,则维度将减小为 :math:`rank+dim[i]`
- **keep_dim** (bool | False):是否在输出Tensor中保留减小的维度。除非 ``keep_dim`` 为true,否则结果张量将比输入少一个维度
- **name** (str | None):这一层的名称(可选)。如果设置为None,则将自动命名这一层
- **input** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64,int32,int64
- **dim** (list | int ,可选)- 求乘积运算的维度。如果为None,则计算所有元素的乘积并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None
- **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** (str , 可选)- 这一层的名称。如果设置为None,则将自动命名这一层。默认值为None
返回: 运算、减少维度之后的Tensor变量
返回: 在指定dim上进行求乘积运算的Tensor,数据类型和输入数据类型一致
返回类型: 变量(Variable)
......@@ -26,7 +26,7 @@ reduce_prod
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# 接下来的示例中,我们在每处函数调用后面都标注出了它的结果张量。
x = fluid.layers.data(name='x', shape=[4, 2], dtype='float32')
x = fluid.layers.data(name='x', shape=[2, 4], dtype='float32')
fluid.layers.reduce_prod(x) # [0.0002268]
fluid.layers.reduce_prod(x, dim=0) # [0.02, 0.06, 0.3, 0.63]
fluid.layers.reduce_prod(x, dim=-1) # [0.027, 0.0084]
......
......@@ -5,15 +5,15 @@ reduce_sum
.. py:function:: paddle.fluid.layers.reduce_sum(input, dim=None, keep_dim=False, name=None)
计算给定维度上张量(Tensor)元素之和
该OP是对指定维度上的Tensor元素进行求和运算,并输出相应的计算结果
参数:
- **input** (Variable)- 输入变量为Tensor或LoDTensor
- **dim** (list | int | None)- 求和运算的维度。如果为None,则对输入的所有元素求和并返回单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input))` 范围内。如果 :math:`dim [i] <0` ,则维度将减小为 :math:`rank+dim[i]`
- **keep_dim** (bool | False)- 是否在输出Tensor中保留减小的维度。除非 ``keep_dim`` 为true,否则结果张量将比输入少一个维度
- **name** (str | None)- 这一层的名称(可选)。如果设置为None,则将自动命名这一层
- **input** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64,int32,int64
- **dim** (list | int ,可选)- 求和运算的维度。如果为None,则计算所有元素的和并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None
- **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** (str , 可选)- 这一层的名称。如果设置为None,则将自动命名这一层。默认值为None
返回: 运算、减少维度之后的Tensor变量
返回: 在指定dim上进行求和运算的Tensor,数据类型和输入数据类型一致
返回类型: 变量(Variable)
......@@ -26,7 +26,7 @@ reduce_sum
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# 接下来的示例中,我们在每处函数调用后面都标注出了它的结果张量。
x = fluid.layers.data(name='x', shape=[4, 2], dtype='float32')
x = fluid.layers.data(name='x', shape=[2, 4], dtype='float32')
fluid.layers.reduce_sum(x) # [3.5]
fluid.layers.reduce_sum(x, dim=0) # [0.3, 0.5, 1.1, 1.6]
fluid.layers.reduce_sum(x, dim=-1) # [1.9, 1.6]
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册