From 010b0ab4441ca82863906e8c009f124973b514e6 Mon Sep 17 00:00:00 2001 From: zhangfanghe Date: Thu, 10 Mar 2022 16:32:03 +0800 Subject: [PATCH] optimizes the documentation of chinese API of ResizeBilinear,HyperMap,ScatterMin,Sqrt,etc. --- docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst | 6 +++++- docs/api/api_python/ops/mindspore.ops.HyperMap.rst | 3 +++ docs/api/api_python/ops/mindspore.ops.ReduceMax.rst | 2 +- docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterMax.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterMin.rst | 4 ++-- docs/api/api_python/ops/mindspore.ops.ScatterMul.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst | 3 ++- .../api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.ScatterSub.rst | 2 +- docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst | 3 ++- docs/api/api_python/ops/mindspore.ops.Sqrt.rst | 3 +++ docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst | 3 +-- 16 files changed, 34 insertions(+), 16 deletions(-) diff --git a/docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst b/docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst index be9a7f6609f..afb1a26d79e 100644 --- a/docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst +++ b/docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst @@ -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。 \ No newline at end of file + - **ValueError** - `size` 是长度不等于2的list或tuple。 + \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.HyperMap.rst b/docs/api/api_python/ops/mindspore.ops.HyperMap.rst index 08078c1b575..99bb4409923 100644 --- a/docs/api/api_python/ops/mindspore.ops.HyperMap.rst +++ b/docs/api/api_python/ops/mindspore.ops.HyperMap.rst @@ -16,6 +16,9 @@ mindspore.ops.HyperMap - **args** (Tuple[sequence]) - 如果 `ops` 不是None，则所有入参都应该是具有相同长度的序列，并且序列的每一行都是运算的输入。如果 `ops` 是None，则第一个入参是运算，其余都是输入。 + .. note:: + 对于算子的输入，输入数量应该等于输入 `ops` 的数量。 + **输出：** 序列或嵌套序列，执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。 diff --git a/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst b/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst index 592982369e2..24ffbb7b802 100644 --- a/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst +++ b/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst @@ -30,4 +30,4 @@ mindspore.ops.ReduceMax - **TypeError** - `keep_dims` 不是bool。 - **TypeError** - `x` 不是tensor。 - - **ValueError** - `axis` 不是int、tuple或list。 \ No newline at end of file + - **TypeError** - `axis` 不是int、tuple或list。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst b/docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst index 18eca0daacc..5c83ca30314 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst @@ -33,4 +33,5 @@ mindspore.ops.ScatterAdd - **TypeError** - `use_locking` 不是bool。 - **TypeError** - `indices` 不是int32。 - - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst b/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst index f6c749abb9b..36fca3dec07 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst @@ -30,4 +30,5 @@ mindspore.ops.ScatterDiv - **TypeError** - `use_locking` 不是bool。 - **TypeError** - `indices` 不是int32。 - - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterMax.rst b/docs/api/api_python/ops/mindspore.ops.ScatterMax.rst index faf40773e3d..a64ec0f75fc 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterMax.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterMax.rst @@ -32,4 +32,5 @@ mindspore.ops.ScatterMax - **TypeError** - `use_locking` 不是bool。 - **TypeError** - `indices` 不是int32。 - - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterMin.rst b/docs/api/api_python/ops/mindspore.ops.ScatterMin.rst index 1140a8c5ab7..702f7b4bda4 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterMin.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterMin.rst @@ -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:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterMul.rst b/docs/api/api_python/ops/mindspore.ops.ScatterMul.rst index c628436ec7e..f62c41af525 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterMul.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterMul.rst @@ -30,4 +30,5 @@ mindspore.ops.ScatterMul - **TypeError** - `use_locking` 不是bool。 - **TypeError** - `indices` 不是int32。 - - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst b/docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst index 179d49737fb..e7e1cbcc8a0 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterNdAdd.rst @@ -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]:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst b/docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst index 6a82f1a01fc..9ae7a399e03 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterNdSub.rst @@ -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]:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst b/docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst index 31d54dea4e9..63b4adbadcb 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst @@ -32,4 +32,5 @@ mindspore.ops.ScatterNdUpdate **异常：** - **TypeError** - `use_locking` 不是bool。 - - **TypeError** - `indices` 不是int32。 \ No newline at end of file + - **TypeError** - `indices` 不是int32。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst b/docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst index fa087b77aa9..35c7f56f3ea 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst @@ -21,4 +21,5 @@ - **TypeError** - `indices` 的数据类型不是int32。 - **TypeError** - `input_x` 的数据类型不是float16、float32或int32。 - - **ValueError** - `updates` 的shape不是 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。 \ No newline at end of file + - **ValueError** - `updates` 的shape不是 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterSub.rst b/docs/api/api_python/ops/mindspore.ops.ScatterSub.rst index fb707e5fe1b..c069b2edc88 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterSub.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterSub.rst @@ -31,4 +31,4 @@ - **TypeError** - `use_locking` 不是bool。 - **TypeError** - `indices` 不是int32。 - **ValueError** - `updates` 的shape不是 `indices_shape + x_shape[1:]` 。 - \ No newline at end of file + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst b/docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst index 9ebab5fec67..6bb66e756e4 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterUpdate.rst @@ -29,4 +29,5 @@ **异常：** - **TypeError** - `use_locking` 不是bool。 - - **TypeError** - `indices` 不是int32。 \ No newline at end of file + - **TypeError** - `indices` 不是int32。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Sqrt.rst b/docs/api/api_python/ops/mindspore.ops.Sqrt.rst index 2dd8638f0ab..ed9a88ec17c 100644 --- a/docs/api/api_python/ops/mindspore.ops.Sqrt.rst +++ b/docs/api/api_python/ops/mindspore.ops.Sqrt.rst @@ -4,6 +4,9 @@ .. py:class:: mindspore.ops.Sqrt 计算输入Tensor的平方根。 + + .. note:: + 当输入数据存在一些负数，则返回负数位置上为NaN的Tensor。 .. math:: out_{i} = \sqrt{x_{i}} diff --git a/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst b/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst index ad10c6b0625..81dec77c5fb 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst @@ -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。 **输出：**