jax.numpy.sum

内容

jax.numpy.sum#

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

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

numpy.sum() 的 JAX 实现。

参数：

  • a (ArrayLike) – 输入数组。

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

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

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

  • keepdims (bool) – bool，默认为 False。如果为 True，则结果中保留大小为 1 的约简轴。

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

  • where (ArrayLike | None | None) – int 或数组，默认为 None。用于计算总和的元素。数组应该与输入广播兼容。

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

返回:

沿给定轴的总和数组。

返回类型:

数组

另请参见

示例

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

>>> 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)
目录