forked from mindspore-Ecosystem/mindspore
correct_clipbynorm_api_doc
This commit is contained in:
parent
ca473a8aed
commit
8a176ca1ad
|
@ -11,12 +11,18 @@ mindspore.ops.clip_by_norm
|
|||
.. note::
|
||||
:math:`L_2`-norm 是对输入Tensor计算 `L_2` 范数。
|
||||
|
||||
**参数:**
|
||||
**输入:**
|
||||
|
||||
- **x** (Tensor) - 任意维度的Tensor。数据类型是 `float16` 或者 `float32` 。
|
||||
- **clip_norm** (Tensor) - 表示裁剪比率的Tensor,数值应该大于0。Shape必须支持能广播至 `x` 的shape。数据类型是 `float16` 或者 `float32` 。
|
||||
- **axis** (Union[None, int, tuple(int), list(int)]) - 执行 :math:`L_2`-norm 计算的维度。默认值: `None` ,表示所有维度。
|
||||
|
||||
**异常:**
|
||||
|
||||
- **TypeError** - `x` 的数据类型不是 `float16` 或者 `float32` 。
|
||||
- **TypeError** - `clip_norm` 的数据类型不是 `float16` 或者 `float32` 。
|
||||
- **TypeError** - `axis` 的类型不是 `None`、`int`、`tuple(int)` 或者 `list(int)` 。
|
||||
|
||||
**返回:**
|
||||
|
||||
Tensor,表示裁剪后的Tensor。其shape和数据类型和 `x` 相同。
|
||||
|
|
|
@ -45,7 +45,7 @@ def clip_by_norm(x, clip_norm, axis=None):
|
|||
TypeError: If `axis` is not one of None, int, tuple(int) and list(int).
|
||||
|
||||
Supported Platforms:
|
||||
``Ascend`` ``GPU`` CPU``
|
||||
``Ascend`` ``GPU`` ``CPU``
|
||||
|
||||
Examples:
|
||||
>>> import numpy as np
|
||||
|
|
|
@ -53,7 +53,7 @@ class ClipByNorm(PrimitiveWithInfer):
|
|||
TypeError: If dtype of `clip_norm` is neither float16 nor float32.
|
||||
|
||||
Supported Platforms:
|
||||
``Ascend`` ``GPU`` CPU``
|
||||
``Ascend`` ``GPU`` ``CPU``
|
||||
|
||||
Examples:
|
||||
>>> import numpy as np
|
||||
|
|
Loading…
Reference in New Issue