jax.numpy.nansum

目录

jax.numpy.nansum#

jax.numpy.nansum(a, axis=None, dtype=None, out=None, keepdims=False, initial=None, where=None)[源代码][源代码]#

返回沿给定轴的数组元素之和，忽略 NaNs。

JAX 实现的 numpy.nansum()。

参数:

  • a (ArrayLike) – 输入数组。

  • axis (Axis) – int 或 int 序列，默认=None。计算总和的轴。如果为 None，则沿展平的数组计算总和。

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

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

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

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

  • out (None) – 未被 JAX 使用。

返回:

一个包含沿指定轴的数组元素之和的数组，忽略 NaN。如果沿指定轴的所有元素都是 NaN，则返回 0。

返回类型:

Array

参见

示例

默认情况下，jnp.nansum 计算沿展平数组的元素之和。

>>> nan = jnp.nan
>>> x = jnp.array([[3, nan, 4, 5],
...                [nan, -2, nan, 7],
...                [2, 1, 6, nan]])
>>> jnp.nansum(x)
Array(26., dtype=float32)

如果 axis=1 ，求和将沿着轴 1 进行计算。

>>> jnp.nansum(x, axis=1)
Array([12.,  5.,  9.], dtype=float32)

如果 keepdims=True ，输出的 ndim 将与输入的相同。

>>> jnp.nansum(x, axis=1, keepdims=True)
Array([[12.],
       [ 5.],
       [ 9.]], dtype=float32)

要在计算总和时仅包含特定元素，可以使用 where。

>>> where=jnp.array([[1, 0, 1, 0],
...                  [0, 0, 1, 1],
...                  [1, 1, 1, 0]], dtype=bool)
>>> jnp.nansum(x, axis=1, keepdims=True, where=where)
Array([[7.],
       [7.],
       [9.]], dtype=float32)

如果 where 在所有元素中都是 False，jnp.nansum 将沿指定轴返回 0。

>>> where = jnp.array([[False],
...                    [False],
...                    [False]])
>>> jnp.nansum(x, axis=0, keepdims=True, where=where)
Array([[0., 0., 0., 0.]], dtype=float32)
目录