!39299 modify the format of API files

Merge pull request !39299 from 宦晓玲/code_docs_0801
This commit is contained in:
i-robot 2022-08-01 06:46:52 +00:00 committed by Gitee
commit d3838f1a7e
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 23 additions and 29 deletions

View File

@ -12,18 +12,15 @@ mindspore.ops.scatter_mul
输入的 `input_x``updates` 遵循隐式类型转换规则以确保数据类型一致。如果数据类型不同则低精度数据类型将转换为高精度的数据类型。当参数的数据类型需要转换时则会抛出RuntimeError异常。
**参数:**
参数:
- **input_x** (Parameter) - ScatterMul的输入任意维度的Parameter。
- **indices** (Tensor) - 指定相乘操作的索引数据类型必须为mindspore.int32。
- **updates** (Tensor) - 指定与 `input_x` 相乘的Tensor数据类型与 `input_x` 相同shape为 `indices.shape + x.shape[1:]`
- **input_x** (Parameter) - ScatterMul的输入任意维度的Parameter。
- **indices** (Tensor) - 指定相乘操作的索引数据类型必须为mindspore.int32。
- **updates** (Tensor) - 指定与 `input_x` 相乘的Tensor数据类型与 `input_x` 相同shape为 `indices.shape + x.shape[1:]`
返回:
Tensor更新后的 `input_x` shape和类型与 `input_x` 相同。
**返回:**
Tensor更新后的 `input_x` shape和类型与 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices.shape + x.shape[1:]`
- **RuntimeError** - 当 `input_x``updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。
异常:
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices.shape + x.shape[1:]`
- **RuntimeError** - 当 `input_x``updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。

View File

@ -17,22 +17,19 @@ mindspore.ops.top_k
如果两个比较的元素相同,则优先返回索引值较小的元素。
**参数:**
参数:
- **input_x** (Tensor) - 需计算的输入数据类型必须为float16、float32或int32。
- **k** (int) - 指定计算最大元素的数量,需要是常量。
- **sorted** (bool, optional) - 如果为True则获取的元素将按值降序排序。默认值True。
- **input_x** (Tensor) - 需计算的输入数据类型必须为float16、float32或int32。
- **k** (int) - 指定计算最大元素的数量,需要是常量。
- **sorted** (bool, optional) - 如果为True则获取的元素将按值降序排序。默认值True。
返回:
2个Tensor组成的tuple `values``indices`
**返回:**
- **values** (Tensor) - 最后一个维度的每个切片中的 `k` 最大元素。
- **indices** (Tensor) - `k` 最大元素的对应索引。
2个Tensor组成的tuple `values``indices`
- **values** (Tensor) - 最后一个维度的每个切片中的 `k` 最大元素。
- **indices** (Tensor) - `k` 最大元素的对应索引。
**异常:**
- **TypeError** - 如果 `sorted` 不是bool。
- **TypeError** - 如果 `input_x` 不是Tensor。
- **TypeError** - 如果 `k` 不是int。
- **TypeError** - 如果 `input_x` 的数据类型不是以下之一float16、float32或int32。
异常:
- **TypeError** - 如果 `sorted` 不是bool。
- **TypeError** - 如果 `input_x` 不是Tensor。
- **TypeError** - 如果 `k` 不是int。
- **TypeError** - 如果 `input_x` 的数据类型不是以下之一float16、float32或int32。