jax.lax.scatter_mul

内容

jax.lax.scatter_mul#

jax.lax.scatter_mul(operand, scatter_indices, updates, dimension_numbers, *, indices_are_sorted=False, unique_indices=False, mode=None)[source]#

散点乘法运算符。

包装 XLA 的 Scatter 运算符，其中乘法用于组合来自 operand 的更新和值。

散点语义很复杂，其 API 可能会在将来发生变化。对于大多数用例，您应该优先使用 JAX 数组上的 jax.numpy.ndarray.at 属性，该属性使用熟悉的 NumPy 索引语法。

参数：

  • operand (ArrayLike) – 应该应用散点的数组

  • scatter_indices (ArrayLike) – 一个数组，给出 operand 中的索引，每个更新在 updates 中应该应用到这些索引。

  • updates (ArrayLike) – 应该散布到 operand 上的更新。

  • dimension_numbers (ScatterDimensionNumbers) – 一个 lax.ScatterDimensionNumbers 对象，它描述了 operand、start_indices、updates 和输出的维度如何相关。

  • indices_are_sorted (bool) – 是否已知 scatter_indices 已排序。如果为真，可能会提高某些后端的性能。

  • unique_indices (bool) – 是否保证 operand 中要更新的元素彼此不重叠。如果为真，可能会提高某些后端的性能。JAX 不会检查此承诺：如果在 unique_indices 为 True 时更新的元素重叠，则行为未定义。

  • mode (str | GatherScatterMode | None | None) – 如何处理越界索引：当设置为 'clip' 时，索引会被截断以确保切片在范围内，当设置为 'fill' 或 'drop' 时，越界更新会被丢弃。当设置为 'promise_in_bounds' 时，越界索引的行为是实现定义的。

返回:

一个包含 operand 与散列更新之和的数组。

返回类型:

数组

目录