diff --git a/docs/api/api_python/ops/mindspore.ops.SquareSumAll.rst b/docs/api/api_python/ops/mindspore.ops.SquareSumAll.rst new file mode 100644 index 00000000000..e6e1c687c7a --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.SquareSumAll.rst @@ -0,0 +1,29 @@ +mindspore.ops.SquareSumAll +========================== + +.. py:class:: mindspore.ops.SquareSumAll + + 计算输入Tensor的平方和。 + + .. math:: + \left\{\begin{matrix}out_{x} = {\textstyle \sum_{0}^{N}} (x_{i})^2 + \\out_{y} = {\textstyle \sum_{0}^{N}} (y_{i})^2 + \end{matrix}\right. + + .. note:: + SquareSumAll只支持float32和float64类型的输入值。 + + **输入:** + + - **x** (Tensor) - SquareSumAll的输入,其数据类型为数值型,shape: :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。 + - **y** (Tensor) - 数据类型和shape与 `x` 相同。 + + **输出:** + + - **output_x** (Tensor) - 数据类型与 `x` 相同。 + - **output_y** (Tensor) - 数据类型与 `x` 相同。 + + **异常:** + + - **TypeError** - 如果 `x` 或 `y` 不是Tensor。 + - **ValueError** - 如果 `x` 与 `y` 的shape不一致。 diff --git a/mindspore/python/mindspore/ops/operations/math_ops.py b/mindspore/python/mindspore/ops/operations/math_ops.py index 43c24d135f5..a894fa9f407 100644 --- a/mindspore/python/mindspore/ops/operations/math_ops.py +++ b/mindspore/python/mindspore/ops/operations/math_ops.py @@ -4630,6 +4630,10 @@ class SquareSumAll(Primitive): ``Ascend`` ``GPU`` ``CPU`` Examples: + >>> import numpy as np + >>> import mindspore + >>> import mindspore.ops as ops + >>> from mindspore import Tensor >>> x = Tensor(np.array([0, 0, 2, 0]), mindspore.float32) >>> y = Tensor(np.array([0, 0, 2, 4]), mindspore.float32) >>> square_sum_all = ops.SquareSumAll()