jax.numpy.sum

jax.numpy.sum(a, axis=None, dtype=None, out=None, keepdims=False, initial=None, where=None, promote_integers=True)

计算数组元素在给定轴上的总和。

JAX 对 numpy.sum() 的实现。

参数:

• a (类数组) – 输入数组。

• axis (Axis | None) – int 或数组，默认值=None。计算总和所沿的轴。如果为 None，则沿所有轴计算总和。

• dtype (DTypeLike | None | None) – 输出数组的类型。默认值=None。

• out (None | None) – JAX 未使用。

• keepdims (bool) – bool，默认值=False。如果为 True，则缩减的轴在结果中保留，大小为 1。

• initial (类数组 | None | None) – int 或数组，默认值=None。总和的初始值。

• where (类数组 | None | None) – int 或数组，默认值=None。用于求和的元素。数组应与输入广播兼容。

• promote_integers (bool) – bool，默认值=True。如果为 True，则整数输入将按照 NumPy 的行为提升为最宽可用的整数 dtype。如果为 False，则结果将具有与输入相同的 dtype。promote_integers 在指定 dtype 时将被忽略。

返回:

沿给定轴的总和的数组。

返回类型:

数组

参见

• jax.numpy.prod()：计算给定轴上数组元素的乘积。

• jax.numpy.max()：计算给定轴上数组元素的最大值。

• jax.numpy.min()：计算给定轴上数组元素的最小值。

示例

默认情况下，沿所有轴计算总和。

>>> x = jnp.array([[1, 3, 4, 2],
...                [5, 2, 6, 3],
...                [8, 1, 3, 9]])
>>> jnp.sum(x)
Array(47, dtype=int32)

如果 axis=1，则沿轴 1 计算总和。

>>> jnp.sum(x, axis=1)
Array([10, 16, 21], dtype=int32)

如果 keepdims=True，则输出的 ndim 等于输入的 ndim。

>>> jnp.sum(x, axis=1, keepdims=True)
Array([[10],
       [16],
       [21]], dtype=int32)

要在总和中仅包含特定元素，可以使用 where。

>>> where=jnp.array([[0, 0, 1, 0],
...                  [0, 0, 1, 1],
...                  [1, 1, 1, 0]], dtype=bool)
>>> jnp.sum(x, axis=1, keepdims=True, where=where)
Array([[ 4],
       [ 9],
       [12]], dtype=int32)
>>> where=jnp.array([[False],
...                  [False],
...                  [False]])
>>> jnp.sum(x, axis=0, keepdims=True, where=where)
Array([[0, 0, 0, 0]], dtype=int32)