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 或陣列，預設值=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) – 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)