mindspore/docs/api/api_python/ops/mindspore.ops.func_sum.rst

25 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2022-12-07 15:53:11 +08:00
mindspore.ops.sum
==================
.. py:function:: mindspore.ops.sum(x, dim=None, keepdim=False, *, dtype=None)
计算Tensor指定维度元素的和。
参数:
- **x** (Tensor) - 输入Tensor。
- **dim** (Union[None, int, tuple(int)]) - 求和的维度。如果 `dim` 为None对Tensor中的所有元素求和。
如果 `dim` 为int组成的tuple将对tuple中的所有维度求和取值范围必须在:math:`[-x.ndim, x.ndim)` 。默认值None。
- **keepdim** (bool) - 是否保持输出Tensor的维度如果为True保持对应的维度且长度为1。如果为False不保持维度。默认值False。
关键字参数:
- **dtype** (:class:`mindspore.dtype`, 可选) - 期望输出Tensor的类型。默认值None。
返回:
Tensor `x` 指定维度的和。
异常:
- **TypeError** - `x` 不是Tensor类型。
- **TypeError** - `dim` 不是Tensor类型。
- **ValueError** - `dim` 取值不在 :math:`[-x.ndim, x.ndim)` 范围。
- **TypeError** - `keepdim` 不是Tensor类型。