diff --git a/docs/api/api_python/mindspore.ops.functional.rst b/docs/api/api_python/mindspore.ops.functional.rst index 609e6f0f3e2..1dac372d648 100644 --- a/docs/api/api_python/mindspore.ops.functional.rst +++ b/docs/api/api_python/mindspore.ops.functional.rst @@ -440,6 +440,7 @@ Array操作 mindspore.ops.dense_to_sparse_coo mindspore.ops.dense_to_sparse_csr mindspore.ops.csr_to_coo + mindspore.ops.sparse_add Parameter操作算子 -------------------- diff --git a/docs/api/api_python/mindspore/mindspore.COOTensor.rst b/docs/api/api_python/mindspore/mindspore.COOTensor.rst index 700f3f8cc18..a90b8e4ebdb 100644 --- a/docs/api/api_python/mindspore/mindspore.COOTensor.rst +++ b/docs/api/api_python/mindspore/mindspore.COOTensor.rst @@ -34,6 +34,38 @@ mindspore.COOTensor 返回: COOTensor。 + .. py:method:: add(other, thresh) + + 与另一个COOTensor相加,并返回新的COOTensor。 + + **参数:** + + - **other** (COOTensor) - 另一个操作数,与当前操作数相加。 + - **thresh** (Tensor) - 0维, 用来决定COOTensor.add结果中的indices/values对是否出现。 + + **返回:** + + COOTensor, 为两COOTensor相加后的结果。 + + **异常:** + - **ValueError** - 如果操作数(本COOTensor/other)的indices的维度不等于2。 + - **ValueError** - 如果操作数(本COOTensor/other)的values的维度不等于1。 + - **ValueError** - 如果操作数(本COOTensor/other)的shape的维度不等于1。 + - **ValueError** - 如果thresh的维度不等于0。 + - **TypeError** - 如果操作数(本COOTensor/other)的indices的数据类型不为int64。 + - **TypeError** - 如果操作数(本COOTensor/other)的shape的数据类型不为int64。 + - **ValueError** - 如果操作数(本COOTensor/other)的indices的长度不等于它的values的长度。 + - **TypeError** - 如果操作数(本COOTensor/other)的values的数据类型不为 + (int8/int16/int32/int64/float32/float64/complex64/complex128)中 + 的任何一个。 + - **TypeError** - 如果thresh的数据类型不为 + (int8/int16/int32/int64/float32/float64)中 + 的任何一个。 + - **TypeError** - 如果操作数(本COOTensor)的indices数据类型不等于other的indices数据类型。 + - **TypeError** - 如果操作数(本COOTensor)的values数据类型不等于other的values数据类型。 + - **TypeError** - 如果操作数(本COOTensor)的shape数据类型不等于other的shape数据类型。 + - **TypeError** - 如果操作数(本COOTensor/other)的values的数据类型与thresh数据类型不匹配。 + .. py:method:: astype(dtype) 返回指定数据类型的COOTensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_sparse_add.rst b/docs/api/api_python/ops/mindspore.ops.func_sparse_add.rst new file mode 100644 index 00000000000..0e56b0a0741 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.func_sparse_add.rst @@ -0,0 +1,35 @@ +mindspore.ops.sparse_add +================================ + +.. py:function:: mindspore.ops.sparse_add(x1, x2, thresh) + + 两个COOTensor相加,根据相加的结果与thresh返回新的COOTensor。 + + **参数:** + + - **x1** (COOTensor) - 一个操作数,与当前操作数相加。 + - **x2** (COOTensor) - 另一个操作数,与当前操作数相加。 + - **thresh** (Tensor) - 0维, 用来决定sparse_add结果中的indices/values对是否出现。 + + **返回:** + + COOTensor, 为两COOTensor相加后的结果。 + + **异常:** + - **ValueError** - 如果操作数(x1/x2)的indices的维度不等于2。 + - **ValueError** - 如果操作数(x1/x2)的values的维度不等于1。 + - **ValueError** - 如果操作数(x1/x2)的shape的维度不等于1。 + - **ValueError** - 如果thresh的维度不等于0。 + - **TypeError** - 如果操作数(x1/x2)的indices的数据类型不为int64。 + - **TypeError** - 如果操作数(x1/x2)的shape的数据类型不为int64。 + - **ValueError** - 如果操作数(x1/x2)的indices的长度不等于它的values的长度。 + - **TypeError** - 如果操作数(x1/x2)的values的数据类型不为 + (int8/int16/int32/int64/float32/float64/complex64/complex128)中 + 的任何一个。 + - **TypeError** - 如果thresh的数据类型不为 + (int8/int16/int32/int64/float32/float64)中 + 的任何一个。 + - **TypeError** - 如果操作数x1的indices数据类型不等于x2的indices数据类型。 + - **TypeError** - 如果操作数x1的values数据类型不等于x2的values数据类型。 + - **TypeError** - 如果操作数x1的shape数据类型不等于x2的shape数据类型。 + - **TypeError** - 如果操作数(x1/x2)的values的数据类型与thresh数据类型不匹配。 diff --git a/docs/api/api_python_en/mindspore.ops.functional.rst b/docs/api/api_python_en/mindspore.ops.functional.rst index 6cab27b4576..26f81a07eb1 100644 --- a/docs/api/api_python_en/mindspore.ops.functional.rst +++ b/docs/api/api_python_en/mindspore.ops.functional.rst @@ -440,6 +440,7 @@ Sparse Operation mindspore.ops.dense_to_sparse_coo mindspore.ops.dense_to_sparse_csr mindspore.ops.csr_to_coo + mindspore.ops.sparse_add Parameter Operation Oprators ----------------------------