diff --git a/docs/api/api_python/mindspore.ops.functional.rst b/docs/api/api_python/mindspore.ops.functional.rst index b842c206364..e81d71ff699 100644 --- a/docs/api/api_python/mindspore.ops.functional.rst +++ b/docs/api/api_python/mindspore.ops.functional.rst @@ -376,6 +376,7 @@ Parameter操作算子 mindspore.ops.assign_add mindspore.ops.assign_sub mindspore.ops.index_add + mindspore.ops.scatter_div mindspore.ops.scatter_min mindspore.ops.scatter_max mindspore.ops.scatter_nd_add diff --git a/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst b/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst index 1c9877617d1..8a42808a4ae 100644 --- a/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst +++ b/docs/api/api_python/ops/mindspore.ops.ScatterDiv.rst @@ -5,12 +5,12 @@ mindspore.ops.ScatterDiv 根据指定更新值和输入索引通过除法运算更新输入数据的值。 - 对于 `indices.shape` 的每个 `i, ..., j` : + 对于 `indices.shape` 的每个 :math:`i, ..., j` : .. math:: \text{input_x}[\text{indices}[i, ..., j], :] \mathrel{/}= \text{updates}[i, ..., j, :] - 输入的 `input_x` 和 `updates` 遵循隐式类型转换规则,以确保数据类型一致。如果数据类型不同,则低精度数据类型将转换为高精度数据类型。当参数的数据类型需要转换时,则会抛出RuntimeError异常。 + 输入的 `input_x` 和 `updates` 遵循隐式类型转换规则,以确保数据类型一致。如果数据类型不同,则低精度数据类型将转换为高精度的数据类型。当 `updates` 不支持转成 `input_x` 需要的数据类型时,则会抛出RuntimeError异常。 **参数:** @@ -19,8 +19,8 @@ mindspore.ops.ScatterDiv **输入:** - **input_x** (Parameter)- ScatterDiv的输入,任意维度的Parameter。 - - **indices** (Tensor) - 指定相除操作的索引,数据类型必须为mindspore.int32。 - - **updates** (Tensor) - 指定与 `input_x` 相除的Tensor,数据类型与 `input_x` 相同,shape为 `indices.shape + x.shape[1:]` 。 + - **indices** (Tensor) - 指定相除操作的索引,数据类型必须为mindspore.int32或者mindspore.int64。 + - **updates** (Tensor) - 指定与 `input_x` 相除的Tensor,数据类型与 `input_x` 相同,shape为 `indices.shape + input_x.shape[1:]` 。 **输出:** @@ -29,6 +29,6 @@ mindspore.ops.ScatterDiv **异常:** - **TypeError** - `use_locking` 不是bool。 - - **TypeError** - `indices` 不是int32。 - - **ValueError** - `updates` 的shape不等于 `indices.shape + x.shape[1:]` 。 + - **TypeError** - `indices` 不是int32或者int64。 + - **ValueError** - `updates` 的shape不等于 `indices.shape + input_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.func_scatter_div.rst b/docs/api/api_python/ops/mindspore.ops.func_scatter_div.rst new file mode 100644 index 00000000000..15905017a8e --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.func_scatter_div.rst @@ -0,0 +1,29 @@ +mindspore.ops.scatter_div +========================= + +.. py:function:: mindspore.ops.scatter_div(input_x, indices, updates) + + 根据指定更新值和输入索引通过除法运算更新输入数据的值。 + + 对于 `indices.shape` 的每个 :math:`i, ..., j` : + + .. math:: + \text{input_x}[\text{indices}[i, ..., j], :] \mathrel{/}= \text{updates}[i, ..., j, :] + + 输入的 `input_x` 和 `updates` 遵循隐式类型转换规则,以确保数据类型一致。如果数据类型不同,则低精度数据类型将转换为高精度的数据类型。当 `updates` 不支持转成 `input_x` 需要的数据类型时,则会抛出RuntimeError异常。 + + **参数:** + + - **input_x** (Parameter) - scatter_div的输入,任意维度的Parameter。 + - **indices** (Tensor) - 指定相除操作的索引,数据类型必须为mindspore.int32或者mindspore.int64。 + - **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor,数据类型与 `input_x` 相同,shape为 `indices.shape + input_x.shape[1:]` 。 + + **输出:** + + Tensor,更新后的 `input_x` ,shape和类型与 `input_x` 相同。 + + **异常:** + + - **TypeError** - `indices` 不是int32或者int64。 + - **ValueError** - `updates` 的shape不等于 `indices.shape + input_x.shape[1:]` 。 + - **RuntimeError** - 当 `input_x` 和 `updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。 \ No newline at end of file diff --git a/docs/api/api_python_en/mindspore.ops.functional.rst b/docs/api/api_python_en/mindspore.ops.functional.rst index d8b3901f4ab..4ebc289ab28 100644 --- a/docs/api/api_python_en/mindspore.ops.functional.rst +++ b/docs/api/api_python_en/mindspore.ops.functional.rst @@ -375,6 +375,7 @@ Parameter Operation Oprators mindspore.ops.assign_add mindspore.ops.assign_sub mindspore.ops.index_add + mindspore.ops.scatter_div mindspore.ops.scatter_min mindspore.ops.scatter_max mindspore.ops.scatter_nd_add