jax.numpy.sum

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

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

numpy.sum() 的 JAX 实现。

参数:

• a (ArrayLike) – 输入数组。

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

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

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

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

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

• where (ArrayLike | None | None) – int 或 array，默认值=None。要在总和中使用的元素。数组应与输入广播兼容。

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

返回值:

沿给定轴的总和数组。

返回类型:

Array

另请参阅

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