From 2db4e5d5a38b2484785cc715560164a1aeb5dae6 Mon Sep 17 00:00:00 2001 From: sunsuodong Date: Wed, 3 Aug 2022 19:52:17 -0700 Subject: [PATCH] add addcdiv and addcmul doc --- .../api_python/ops/mindspore.ops.Addcdiv.rst | 24 +++++++++++++++++ .../api_python/ops/mindspore.ops.Addcmul.rst | 27 +++++++++++++++++++ .../mindspore/ops/operations/math_ops.py | 2 +- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/api/api_python/ops/mindspore.ops.Addcdiv.rst create mode 100644 docs/api/api_python/ops/mindspore.ops.Addcmul.rst diff --git a/docs/api/api_python/ops/mindspore.ops.Addcdiv.rst b/docs/api/api_python/ops/mindspore.ops.Addcdiv.rst new file mode 100644 index 00000000000..619caf52d17 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Addcdiv.rst @@ -0,0 +1,24 @@ +mindspore.ops.Addcdiv +======================== + +.. py:class:: mindspore.ops.Addcdiv + + 执行张量x1与张量x2的逐元素除法,将结果乘以标量值value,并将其添加到input_data中。 + + .. math:: + y[i] = input\_data[i] + value[i] * (x1[i] / x2[i]) + + 输入: + - **input_data** (Tensor) - 要添加的张量。 + - **x1** (Tensor) - 分子张量。 + - **x2** (Tensor) - 分母张量。 + - **value** (Tensor) - 张量x1/x2的乘数。 + + 输出: + Tensor,具有与x1/x2相同的形状和dtype。 + + 异常: + - **TypeError** - 如果 `x1` 、 `x2` 、 `value` 、 `input_data` 的dtype不是张量。 + - **ValueError** - 如果无法将 `x1` 广播到形状为 `x2` 的张量。 + - **ValueError** - 如果无法将 `value` 广播到形状为 `x1/x2` 的张量。 + - **ValueError** - 如果无法将 `input_data` 广播到形状为 `value*(x1/x2)` 的张量。 diff --git a/docs/api/api_python/ops/mindspore.ops.Addcmul.rst b/docs/api/api_python/ops/mindspore.ops.Addcmul.rst new file mode 100644 index 00000000000..c51928187e5 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Addcmul.rst @@ -0,0 +1,27 @@ +mindspore.ops.Addcmul +======================== + +.. py:class:: mindspore.ops.Addcmul + + 执行张量x1与张量x2的逐元素乘积,将结果乘以标量值value,并将其添加到input_data中。 + + .. math:: + output[i] = input\_data[i] + value[i] * (x1[i] * x2[i]) + + 输入: + - **input_data** (Tensor) - 要添加的张量。 + - **x1** (Tensor) - 要乘以的张量。 + - **x2** (Tensor) - 要乘以的张量。 + - **value** (Tensor) - 张量x1*x2的乘数。 + + 输出: + Tensor,具有与x1*x2相同的形状和dtype。 + + 异常: + - **TypeError** - 如果 `x1` 、 `x2` 、 `value` 、 `input_data` 的dtype不是张量。 + - **TypeError** - 如果 `input_data` 的dtype不是:float32、float16、int32之一。 + - **TypeError** - 如果 `x1` 或 `x2` 的dtype不是:float32、float16、int32之一. + - **TypeError** - 如果 `value` 的dtype不是:float32、float16、int32之一。 + - **ValueError** - 如果无法将 `x1` 广播到形状为 `x2` 的张量。 + - **ValueError** - 如果无法将 `value` 广播到形状为 `x1` * `x2` 的张量。 + - **ValueError** - 如果无法将 `input_data` 广播到形状为 `value*(x1*x2)` 的张量。 diff --git a/mindspore/python/mindspore/ops/operations/math_ops.py b/mindspore/python/mindspore/ops/operations/math_ops.py index 8b60d6016d3..019e452278f 100644 --- a/mindspore/python/mindspore/ops/operations/math_ops.py +++ b/mindspore/python/mindspore/ops/operations/math_ops.py @@ -258,7 +258,7 @@ class Addcdiv(Primitive): - **value** (Tensor) - The multiplier for tensor x1/x2. Outputs: - Tensor y, has the same shape and dtype as x1/x2. + Tensor, has the same shape and dtype as x1/x2. Raises: TypeError: If dtype of `x1`, `x2`, `value`, `input_data` is not tensor.