jax.ops.segment_sum#

jax.ops.segment_sum(data, segment_ids, num_segments=None, indices_are_sorted=False, unique_indices=False, bucket_size=None, mode=None)[source]#

计算数组分段内的总和。

类似于 TensorFlow 的 segment_sum

参数:

  • data (ArrayLike) – 要进行求和的数值数组。

  • segment_ids (ArrayLike) – 整数类型的数组，指示要进行求和的 data 的分段（沿其前导轴）。值可以重复，无需排序。

  • num_segments (int | None | None) – 可选，一个非负整数值，指示分段的数量。默认值设置为支持 segment_ids 中所有索引的最小分段数，计算公式为 max(segment_ids) + 1。由于 num_segments 确定输出的大小，因此必须提供静态值才能在 JIT 编译的函数中使用 segment_sum。

  • indices_are_sorted (bool) – segment_ids 是否已知已排序。

  • unique_indices (bool) – segment_ids 是否已知没有重复项。

  • bucket_size (int | None | None) – 将索引分组到的 bucket 大小。segment_sum 在每个 bucket 上单独执行，以提高加法的数值稳定性。默认 None 表示不进行 bucketing。

  • mode (lax.GatherScatterMode | None | None) – jax.lax.GatherScatterMode 值，描述如何处理越界索引。默认情况下，范围 [0, num_segments) 之外的值将被丢弃，并且不计入总和。

返回:

形状为 (num_segments,) + data.shape[1:] 的数组，表示分段总和。

返回类型:

Array

示例

简单的一维分段求和

>>> data = jnp.arange(5)
>>> segment_ids = jnp.array([0, 0, 1, 1, 2])
>>> segment_sum(data, segment_ids)
Array([1, 5, 4], dtype=int32)

使用 JIT 需要静态 num_segments

>>> from jax import jit
>>> jit(segment_sum, static_argnums=2)(data, segment_ids, 3)
Array([1, 5, 4], dtype=int32)