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 (ArrayLike) – 输入数组。

• axis (Axis) – 整型或数组，默认值=None。计算和的轴。如果为 None，则对所有轴计算和。

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

• out (None) – JAX 未使用

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

• initial (ArrayLike | None) – 整型或数组，默认值=None。和的初始值。

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

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

返回:

沿给定轴求和的数组。

返回类型:

数组

另请参阅

• 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)