!39212 [MSLITE][CPU] reduce op functional api docs update

Merge pull request !39212 from Greatpan/code_docs
This commit is contained in:
i-robot 2022-07-30 07:52:20 +00:00 committed by Gitee
commit e765130de4
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
7 changed files with 107 additions and 19 deletions

View File

@ -235,11 +235,15 @@ Reduction函数
:nosignatures:
:template: classtemplate.rst
mindspore.ops.amax
mindspore.ops.amin
mindspore.ops.argmin
mindspore.ops.logsumexp
mindspore.ops.max
mindspore.ops.norm
mindspore.ops.mean
mindspore.ops.min
mindspore.ops.norm
mindspore.ops.prod
.. list-table::
:widths: 50 50
@ -247,14 +251,6 @@ Reduction函数
* - functional
- Description
* - mindspore.ops.amax
- Refer to :class:`mindspore.ops.ReduceMax`.
* - mindspore.ops.mean
- Refer to :class:`mindspore.ops.ReduceMean`.
* - mindspore.ops.amin
- Refer to :class:`mindspore.ops.ReduceMin`.
* - mindspore.ops.prod
- Refer to :class:`mindspore.ops.ReduceProd`.
* - mindspore.ops.reduce_sum
- Refer to :class:`mindspore.ops.ReduceSum`.

View File

@ -14,7 +14,7 @@
- **axis** (Union[int, tuple(int), list(int)]) - 要减少的维度。默认值: (),缩小所有维度。只允许常量值。取值必须在[-rank( `x` ), rank( `x` ))范围内。
输出:
bool类型的Tensor。
Tensor。
- 如果 `axis` 为(),且 `keep_dims` 为False
则输出一个0维Tensor表示输入Tensor中所有元素的乘积。

View File

@ -0,0 +1,24 @@
mindspore.ops.amax
==================
.. py:function:: mindspore.ops.amax(x, axis=(), keep_dims=False)
默认情况下使用指定维度的最大值代替该维度的其他元素以移除该维度。也可仅缩小该维度大小至1。 `keep_dims` 控制输出和输入的维度是否相同。
参数:
- **x** (Tensor[Number]) - 输入Tensor。
shape: :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度其秩应小于8。
- **axis** (Union[int, tuple(int), list(int)]) - 要减少的维度。默认值: (),缩小所有维度。只允许常量值。取值必须在[-rank( `x` ), rank( `x` ))范围内。
- **keep_dims** (bool) - 如果为True则保留缩小的维度大小为1。否则移除维度。默认值False。
返回:
Tensor。
- 如果 `axis` 为(),且 `keep_dims` 为False则输出一个0维Tensor表示输入Tensor中所有元素的最大值。
- 如果 `axis` 为int值为2并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_3, ..., x_R)`
- 如果 `axis` 为tuple(int),值为(2, 3),并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_4, ..., x_R)`
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `axis` 不是以下数据类型之一int、Tuple或List。
- **TypeError** - `keep_dims` 不是bool类型。

View File

@ -0,0 +1,24 @@
mindspore.ops.amin
==================
.. py:function:: mindspore.ops.amin(x, axis=(), keep_dims=False)
默认情况下使用指定维度的最小值代替该维度的其他元素以移除该维度。也可仅缩小该维度大小至1。 `keep_dims` 控制输出和输入的维度是否相同。
参数:
- **x** (Tensor[Number]) - 输入Tensor。
shape: :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度其秩应小于8。
- **axis** (Union[int, tuple(int), list(int)]) - 要减少的维度。默认值: (),缩小所有维度。只允许常量值。取值必须在[-rank( `x` ), rank( `x` ))范围内。
- **keep_dims** (bool) - 如果为True则保留缩小的维度大小为1。否则移除维度。默认值False。
返回:
Tensor。
- 如果 `axis` 为(),且 `keep_dims` 为False则输出一个0维Tensor表示输入Tensor中所有元素的最小值。
- 如果 `axis` 为int值为2并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_3, ..., x_R)`
- 如果 `axis` 为tuple(int),值为(2, 3),并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_4, ..., x_R)`
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `axis` 不是以下数据类型之一int、Tuple或List。
- **TypeError** - `keep_dims` 不是bool类型。

View File

@ -0,0 +1,24 @@
mindspore.ops.mean
==================
.. py:function:: mindspore.ops.mean(x, axis=(), keep_dims=False)
默认情况下输出Tensor各维度上的平均值以达到对所有维度进行归约的目的。也可以对指定维度进行求平均值归约。
参数:
- **x** (Tensor[Number]) - 输入Tensor。
shape: :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度其秩应小于8。
- **axis** (Union[int, tuple(int), list(int)]) - 要减少的维度。默认值: (),缩小所有维度。只允许常量值。取值必须在[-rank( `x` ), rank( `x` ))范围内。
- **keep_dims** (bool) - 如果为True则保留缩小的维度大小为1。否则移除维度。默认值False。
返回:
Tensor。
- 如果 `axis` 为(),且 `keep_dims` 为False则输出一个0维Tensor表示输入Tensor中所有元素的平均值。
- 如果 `axis` 为int值为2并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_3, ..., x_R)`
- 如果 `axis` 为tuple(int),值为(2, 3),并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_4, ..., x_R)`
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `axis` 不是以下数据类型之一int、Tuple或List。
- **TypeError** - `keep_dims` 不是bool类型。

View File

@ -0,0 +1,24 @@
mindspore.ops.prod
==================
.. py:function:: mindspore.ops.prod(x, axis=(), keep_dims=False)
默认情况下通过计算指定维度中所有元素的乘积来移除该维度。也可仅缩小该维度大小至1。 `keep_dims` 控制输出和输入的维度是否相同。
参数:
- **x** (Tensor[Number]) - 输入Tensor。
shape: :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度其秩应小于8。
- **axis** (Union[int, tuple(int), list(int)]) - 要减少的维度。默认值: (),缩小所有维度。只允许常量值。取值必须在[-rank( `x` ), rank( `x` ))范围内。
- **keep_dims** (bool) - 如果为True则保留缩小的维度大小为1。否则移除维度。默认值False。
返回:
Tensor。
- 如果 `axis` 为(),且 `keep_dims` 为False则输出一个0维Tensor表示输入Tensor中所有元素的乘积。
- 如果 `axis` 为int值为2并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_3, ..., x_R)`
- 如果 `axis` 为tuple(int),值为(2, 3),并且 `keep_dims` 为False则输出Tensor的shape为 :math:`(x_1, x_4, ..., x_R)`
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `axis` 不是以下数据类型之一int、Tuple或List。
- **TypeError** - `keep_dims` 不是bool类型。

View File

@ -237,11 +237,15 @@ Reduction Functions
:nosignatures:
:template: classtemplate.rst
mindspore.ops.amax
mindspore.ops.amin
mindspore.ops.argmin
mindspore.ops.logsumexp
mindspore.ops.max
mindspore.ops.norm
mindspore.ops.mean
mindspore.ops.min
mindspore.ops.norm
mindspore.ops.prod
.. list-table::
:widths: 50 50
@ -249,14 +253,6 @@ Reduction Functions
* - functional
- Description
* - mindspore.ops.amax
- Refer to :class:`mindspore.ops.ReduceMax`.
* - mindspore.ops.mean
- Refer to :class:`mindspore.ops.ReduceMean`.
* - mindspore.ops.amin
- Refer to :class:`mindspore.ops.ReduceMin`.
* - mindspore.ops.prod
- Refer to :class:`mindspore.ops.ReduceProd`.
* - mindspore.ops.reduce_sum
- Refer to :class:`mindspore.ops.ReduceSum`.