Nigel
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

optimizes the documentation of chinese API of ResizeBilinear,HyperMap,ScatterMin,Sqrt,etc.

This commit is contained in:
zhangfanghe 2022-03-10 16:32:03 +08:00
parent d2c23394d8
commit 010b0ab444
16 changed files with 34 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst
View File

@ -27,8 +27,12 @@ mindspore.nn.ResizeBilinear
- **TypeError** - `size` 不是tuple、list或None。
- **TypeError** - `scale_factor` 既不是int也不是None。
- **TypeError** - `align_corners` 不是bool。
- **TypeError** - `half_pixel_centers` 不是bool。
- **TypeError** - `align_corners` 和 `half_pixel_centers` 都为bool。
- **TypeError** - `half_pixel_centers` 为True，且device_target不为Ascend。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **ValueError** - `size` 和 `scale_factor` 都为None或都不为None。
- **ValueError** - `x` 的shape长度不等于4。
- **ValueError** - `scale_factor` 是小于0的int。
- **ValueError** - `size` 是长度不等于2的list或tuple。
- **ValueError** - `size` 是长度不等于2的list或tuple。

3
docs/api/api_python/ops/mindspore.ops.HyperMap.rst
View File

@ -16,6 +16,9 @@ mindspore.ops.HyperMap
- **args** (Tuple[sequence]) - 如果 `ops` 不是None，则所有入参都应该是具有相同长度的序列，并且序列的每一行都是运算的输入。如果 `ops` 是None，则第一个入参是运算，其余都是输入。
.. note::
对于算子的输入，输入数量应该等于输入 `ops` 的数量。
**输出：**
序列或嵌套序列，执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。

2
docs/api/api_python/ops/mindspore.ops.ReduceMax.rst
View File

@ -30,4 +30,4 @@ mindspore.ops.ReduceMax
- **TypeError** - `keep_dims` 不是bool。
- **TypeError** - `x` 不是tensor。
- **ValueError** - `axis` 不是int、tuple或list。
- **TypeError** - `axis` 不是int、tuple或list。

3
docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst
View File

@ -33,4 +33,5 @@ mindspore.ops.ScatterAdd
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst
View File

@ -30,4 +30,5 @@ mindspore.ops.ScatterDiv
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterMax.rst
View File

@ -32,4 +32,5 @@ mindspore.ops.ScatterMax
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

4
docs/api/api_python/ops/mindspore.ops.ScatterMin.rst
View File

@ -22,7 +22,6 @@ mindspore.ops.ScatterMin
- **input_x** (Parameter) - ScatterMin的输入，任意维度的Parameter。
- **indices** (Tensor) - 指定最小值操作的索引，数据类型必须为mindspore.int32。
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor，数据类型与 `input_x` 相同，shape为 `indices_shape + x_shape[1:]` 。
**输出：**
@ -32,4 +31,5 @@ mindspore.ops.ScatterMin
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterMul.rst
View File

@ -30,4 +30,5 @@ mindspore.ops.ScatterMul
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst
View File

@ -34,4 +34,5 @@ mindspore.ops.ScatterNdAdd
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst
View File

@ -33,4 +33,5 @@ mindspore.ops.ScatterNdSub
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst
View File

@ -32,4 +32,5 @@ mindspore.ops.ScatterNdUpdate
**异常：**
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **TypeError** - `indices` 不是int32。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst
View File

@ -21,4 +21,5 @@
- **TypeError** - `indices` 的数据类型不是int32。
- **TypeError** - `input_x` 的数据类型不是float16、float32或int32。
- **ValueError** - `updates` 的shape不是 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **ValueError** - `updates` 的shape不是 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

2
docs/api/api_python/ops/mindspore.ops.ScatterSub.rst
View File

@ -31,4 +31,4 @@
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **ValueError** - `updates` 的shape不是 `indices_shape + x_shape[1:]` 。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst
View File

@ -29,4 +29,5 @@
**异常：**
- **TypeError** - `use_locking` 不是bool。
- **TypeError** - `indices` 不是int32。
- **TypeError** - `indices` 不是int32。
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。

3
docs/api/api_python/ops/mindspore.ops.Sqrt.rst
View File

@ -4,6 +4,9 @@
.. py:class:: mindspore.ops.Sqrt
计算输入Tensor的平方根。
.. note::
当输入数据存在一些负数，则返回负数位置上为NaN的Tensor。
.. math::
out_{i} = \sqrt{x_{i}}

3
docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.batch_dot
=======================
.. py:function:: mindspore.ops.batch_dot(x1, x2, axes=None, prim_name=None)
.. py:function:: mindspore.ops.batch_dot(x1, x2, axes=None)
当输入的两个Tensor是批量数据时，对其进行批量点积操作。
@ -13,7 +13,6 @@ mindspore.ops.batch_dot
- **x1** (Tensor) - 第一个输入Tensor，数据类型为float32且 `x1` 的秩必须大于或等于2。
- **x2** (Tensor) - 第二个输入Tensor，数据类型为float32。 `x2` 的数据类型应与 `x1` 相同，`x2` 的秩必须大于或等于2。
- **axes** (Union[int, tuple(int), list(int)]) - 指定为单值或长度为2的tuple和list，分别指定 `a` 和 `b` 的维度。如果传递了单个值 `N`，则自动从输入 `a` 的shape中获取最后N个维度，从输入 `b` 的shape中获取最后N个维度，分别作为每个维度的轴。默认值：None。
- **prim_name** (Union[str,None]) - 指定算子名。默认值：None。
**输出：**