!35374 doc for renorm op

Merge pull request !35374 from liubuyu/doc
This commit is contained in:
i-robot 2022-06-07 02:50:40 +00:00 committed by Gitee
commit 375196215f
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
4 changed files with 47 additions and 0 deletions

View File

@ -258,6 +258,7 @@ Reduction算子
mindspore.ops.matmul
mindspore.ops.cdist
mindspore.ops.ger
mindspore.ops.renorm
Tensor操作算子
----------------

View File

@ -1037,6 +1037,27 @@ mindspore.Tensor
一维Tensor含有与输入相同的元素。
.. py:method:: renorm(p, dim, maxnorm)
沿维度 `dim` 重新规范Tensor的子张量并且每个子张量的p范数不超过给定的最大范数 `maxnorm`
如果子张量的p范数小于 `maxnorm` 则当前子张量不需要修改否则该子张量需要修改为对应位置的原值除以该子张量的p范数然后再乘上 `maxnorm`
**参数:**
- **p** (int) - 范数。
- **dim** (int) - 维度。
- **maxnorm** (float) - 给定的最大范数。
**返回:**
Tensorshape和type与输入Tensor一致。
**异常:**
- **TypeError** - `p` 不是int类型。
- **TypeError** - `dim` 不是int类型。
- **TypeError** - `maxnorm` 不是float类型。
- **ValueError** - `p` 小于等于0。
.. py:method:: repeat(repeats, axis=None)
对数组中的元素进行重复复制。

View File

@ -0,0 +1,24 @@
mindspore.ops.renorm
====================
.. py:function:: mindspore.ops.renorm(input_x, p, dim, maxnorm)
沿维度 `dim` 重新规范输入 `input_x` 的子张量并且每个子张量的p范数不超过给定的最大范数 `maxnorm`
如果子张量的p范数小于 `maxnorm` 则当前子张量不需要修改否则该子张量需要修改为对应位置的原值除以该子张量的p范数然后再乘上 `maxnorm`
**参数:**
- **input_x** (Tensor) - 输入张量。
- **p** (int) - 范数。
- **dim** (int) - 维度。
- **maxnorm** (float) - 给定的最大范数。
**返回:**
Tensorshape和type与输入Tensor一致。
**异常:**
- **TypeError** - `p` 不是int类型。
- **TypeError** - `dim` 不是int类型。
- **TypeError** - `maxnorm` 不是float类型。
- **ValueError** - `p` 小于等于0。

View File

@ -257,6 +257,7 @@ Linear Algebraic Operators
mindspore.ops.matmul
mindspore.ops.cdist
mindspore.ops.ger
mindspore.ops.renorm
Tensor Operation Operators
--------------------------