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)[源代码][源代码]#

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

JAX 实现的 numpy.sum()。

参数:

  • a (ArrayLike) – 输入数组。

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

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

  • out (None) – 未被JAX使用

  • keepdims (bool) – bool, 默认=False。如果为真，缩减的轴将保留在结果中，尺寸为1。

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

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

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

返回:

沿着给定轴的和的数组。

返回类型:

Array

参见

示例

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

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