jax.numpy.unique_all

内容

jax.numpy.unique_all#

jax.numpy.unique_all(x, /, *, size=None, fill_value=None)[source]#

返回来自 x 的唯一值，以及索引、反向索引和计数。

numpy.unique_all() 的 JAX 实现；这等效于调用 jax.numpy.unique() 并将 return_index、return_inverse、return_counts 和 equal_nan 设置为 True。

由于 unique_all 输出的大小取决于数据，因此该函数通常与 jit() 和其他 JAX 转换不兼容。JAX 版本添加了可选的 size 参数，该参数必须静态指定才能在这些上下文中使用 jnp.unique。

参数：

  • x (ArrayLike) – 将从中提取唯一值的 N 维数组。

  • size (int | None | None) – 如果指定，则仅返回前 size 个排序后的唯一元素。如果唯一元素的数量少于 size 指示的数量，则返回值将用 fill_value 填充。

  • fill_value (ArrayLike | None | None) – 当 size 指定且元素数量少于指示的数量时，用 fill_value 填充剩余的条目。默认为最小唯一值。

返回:

  • values:

    形状为 (n_unique,) 的数组，包含来自 x 的唯一值。

  • indices:

    形状为 (n_unique,) 的数组。包含 x 中每个唯一值的第一次出现的索引。对于一维输入，x[indices] 等价于 values。

  • inverse_indices:

    形状为 x.shape 的数组。包含 x 中每个值在 values 中的索引。对于一维输入，values[inverse_indices] 等价于 x。

  • counts:

    形状为 (n_unique,) 的数组。包含 x 中每个唯一值的出现次数。

返回类型:

一个元组 (values, indices, inverse_indices, counts)，具有以下属性

另请参阅

示例

这里我们计算一维数组中的唯一值

>>> x = jnp.array([3, 4, 1, 3, 1])
>>> result = jnp.unique_all(x)

结果是一个具有四个命名属性的 NamedTuple。 values 属性包含数组中的唯一值

>>> result.values
Array([1, 3, 4], dtype=int32)

indices 属性包含输入数组中唯一 values 的索引

>>> result.indices
Array([2, 0, 1], dtype=int32)
>>> jnp.all(result.values == x[result.indices])
Array(True, dtype=bool)

inverse_indices 属性包含输入在 values 中的索引

>>> result.inverse_indices
Array([1, 2, 0, 1, 0], dtype=int32)
>>> jnp.all(x == result.values[result.inverse_indices])
Array(True, dtype=bool)

counts 属性包含输入中每个唯一值的计数

>>> result.counts
Array([2, 2, 1], dtype=int32)

有关 size 和 fill_value 参数的示例，请参阅 jax.numpy.unique()。

目录