jax.numpy.max

内容

jax.numpy.max#

jax.numpy.max(a, axis=None, out=None, keepdims=False, initial=None, where=None)[source]#

返回沿给定轴的数组元素的最大值。

numpy.max() 的 JAX 实现。

参数:
  • a (ArrayLike) – 输入数组。

  • axis (Axis | None) – int 或数组,默认为 None。计算最大值的轴。如果为 None,则沿所有轴计算最大值。

  • keepdims (bool) – bool,默认为 False。如果为 True,则保留结果中大小为 1 的已缩减轴。

  • initial (ArrayLike | None | None) – int 或数组,默认为 None。最大值的初始值。

  • where (ArrayLike | None | None) – int 或布尔类型数组,默认为 None。用于计算最大值的元素。数组应与输入广播兼容。initial 必须在使用 where 时指定。

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

返回:

沿给定轴的最大值数组。

返回类型:

数组

另请参阅

示例

默认情况下,jnp.max 计算所有轴上元素的最大值。

>>> x = jnp.array([[9, 3, 4, 5],
...                [5, 2, 7, 4],
...                [8, 1, 3, 6]])
>>> jnp.max(x)
Array(9, dtype=int32)

如果 axis=1,则沿轴 1 计算最大值。

>>> jnp.max(x, axis=1)
Array([9, 7, 8], dtype=int32)

如果 keepdims=True,则输出的 ndim 与输入的相同。

>>> jnp.max(x, axis=1, keepdims=True)
Array([[9],
       [7],
       [8]], dtype=int32)

要仅包含特定元素来计算最大值,可以使用 where。它可以具有与输入相同的维度

>>> where=jnp.array([[0, 0, 1, 0],
...                  [0, 0, 1, 1],
...                  [1, 1, 1, 0]], dtype=bool)
>>> jnp.max(x, axis=1, keepdims=True, initial=0, where=where)
Array([[4],
       [7],
       [8]], dtype=int32)

或者必须与输入广播兼容。

>>> where = jnp.array([[False],
...                    [False],
...                    [False]])
>>> jnp.max(x, axis=0, keepdims=True, initial=0, where=where)
Array([[0, 0, 0, 0]], dtype=int32)