forked from mindspore-Ecosystem/mindspore
optimizes the documentation of chinese API of ResizeBilinear,HyperMap,ScatterMin,Sqrt,etc.
This commit is contained in:
zhangfanghe
parent
d2c23394d8
commit
010b0ab444
|
|
@ -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。
|
||||
|
||||
|
|
@ -16,6 +16,9 @@ mindspore.ops.HyperMap
|
|||
|
||||
- **args** (Tuple[sequence]) - 如果 `ops` 不是None，则所有入参都应该是具有相同长度的序列，并且序列的每一行都是运算的输入。如果 `ops` 是None，则第一个入参是运算，其余都是输入。
|
||||
|
||||
.. note::
|
||||
对于算子的输入，输入数量应该等于输入 `ops` 的数量。
|
||||
|
||||
**输出：**
|
||||
|
||||
序列或嵌套序列，执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ mindspore.ops.ReduceMax
|
|||
|
||||
- **TypeError** - `keep_dims` 不是bool。
|
||||
- **TypeError** - `x` 不是tensor。
|
||||
- **ValueError** - `axis` 不是int、tuple或list。
|
||||
- **TypeError** - `axis` 不是int、tuple或list。
|
||||
|
|
@ -34,3 +34,4 @@ mindspore.ops.ScatterAdd
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
|
|||
|
|
@ -31,3 +31,4 @@ mindspore.ops.ScatterDiv
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -33,3 +33,4 @@ mindspore.ops.ScatterMax
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -23,7 +23,6 @@ mindspore.ops.ScatterMin
|
|||
- **indices** (Tensor) - 指定最小值操作的索引，数据类型必须为mindspore.int32。
|
||||
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor，数据类型与 `input_x` 相同，shape为 `indices_shape + x_shape[1:]` 。
|
||||
|
||||
|
||||
**输出：**
|
||||
|
||||
Tensor，更新后的 `input_x` ，shape和类型与 `input_x` 相同。
|
||||
|
|
@ -33,3 +32,4 @@ mindspore.ops.ScatterMin
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -31,3 +31,4 @@ mindspore.ops.ScatterMul
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape + x_shape[1:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -35,3 +35,4 @@ mindspore.ops.ScatterNdAdd
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -34,3 +34,4 @@ mindspore.ops.ScatterNdSub
|
|||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **ValueError** - `updates` 的shape不等于 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -33,3 +33,4 @@ mindspore.ops.ScatterNdUpdate
|
|||
|
||||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -22,3 +22,4 @@
|
|||
- **TypeError** - `indices` 的数据类型不是int32。
|
||||
- **TypeError** - `input_x` 的数据类型不是float16、float32或int32。
|
||||
- **ValueError** - `updates` 的shape不是 `indices_shape[:-1] + x_shape[indices_shape[-1]:]` 。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -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` 需要的数据类型，就会报错。
|
||||
|
|
@ -30,3 +30,4 @@
|
|||
|
||||
- **TypeError** - `use_locking` 不是bool。
|
||||
- **TypeError** - `indices` 不是int32。
|
||||
- **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致，需要进行类型转换时，如果 `updates` 不支持转成参数 `input_x` 需要的数据类型，就会报错。
|
||||
|
|
@ -5,6 +5,9 @@
|
|||
|
||||
计算输入Tensor的平方根。
|
||||
|
||||
.. note::
|
||||
当输入数据存在一些负数，则返回负数位置上为NaN的Tensor。
|
||||
|
||||
.. math::
|
||||
out_{i} = \sqrt{x_{i}}
|
||||
|
||||
|
|
|
|||
|
|
@ -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。
|
||||
|
||||
**输出：**
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue