jax.numpy.take#

jax.numpy.take(a, indices, axis=None, out=None, mode=None, unique_indices=False, indices_are_sorted=False, fill_value=None)[源代码]#

从数组中提取元素。

JAX 对 numpy.take() 的实现，基于 jax.lax.gather() 实现。在索引超出边界的情况下，JAX 的行为与 NumPy 不同；请参阅下面的 mode 参数。

参数:

  • a (ArrayLike) – 要从中提取值的数组。

  • indices (ArrayLike) – N 维整数索引数组，用于指定要从数组中提取的值。

  • axis (int | None | None) – 要沿其提取值的轴。 如果未指定，则在应用索引之前，数组将被展平。

  • mode (str | None | None) – 超出边界的索引模式，可以是 "fill" 或 "clip"。默认的 mode="fill" 对于超出边界的索引返回无效值（例如 NaN）； fill_value 参数控制此值。有关 mode 选项的更多讨论，请参阅 jax.numpy.ndarray.at。

  • fill_value (StaticScalar | None | None) – 当 mode 为 ‘fill’ 时，对于超出边界的切片返回的填充值。 否则将被忽略。对于非精确类型，默认为 NaN；对于有符号类型，默认为最大负值；对于无符号类型，默认为最大正值；对于布尔值，默认为 True。

  • unique_indices (bool) – 如果为 True，则实现会假定索引是唯一的，这可以在某些后端上实现更高效的执行。如果设置为 True 且索引不是唯一的，则输出未定义。

  • indices_are_sorted (bool) – 如果为 True，则实现会假定索引按升序排序，这可以在某些后端上实现更高效的执行。如果设置为 True 且索引未排序，则输出未定义。

  • out (None | None)

返回:

从 a 中提取的值的数组。

返回类型:

数组

另请参阅

示例

>>> x = jnp.array([[1., 2., 3.],
...                [4., 5., 6.]])
>>> indices = jnp.array([2, 0])

不传递 axis 参数会导致索引到展平的数组中

>>> jnp.take(x, indices)
Array([3., 1.], dtype=float32)
>>> x.ravel()[indices]  # equivalent indexing syntax
Array([3., 1.], dtype=float32)

传递 axis 参数会导致将索引应用到沿该轴的每个子数组

>>> jnp.take(x, indices, axis=1)
Array([[3., 1.],
       [6., 4.]], dtype=float32)
>>> x[:, indices]  # equivalent indexing syntax
Array([[3., 1.],
       [6., 4.]], dtype=float32)

超出边界的索引将填充无效值。对于浮点输入，这是 NaN

>>> jnp.take(x, indices, axis=0)
Array([[nan, nan, nan],
       [ 1.,  2.,  3.]], dtype=float32)
>>> x.at[indices].get(mode='fill', fill_value=jnp.nan)  # equivalent indexing syntax
Array([[nan, nan, nan],
       [ 1.,  2.,  3.]], dtype=float32)

可以使用 mode 参数调整此默认的超出边界行为，例如，我们可以改为剪切到最后一个有效值

>>> jnp.take(x, indices, axis=0, mode='clip')
Array([[4., 5., 6.],
       [1., 2., 3.]], dtype=float32)
>>> x.at[indices].get(mode='clip')  # equivalent indexing syntax
Array([[4., 5., 6.],
       [1., 2., 3.]], dtype=float32)