jax.lax.scan

jax.lax.scan#

jax.lax.scan(f, init, xs=None, length=None, reverse=False, unroll=1, _split_transpose=False)[源代码]#

在执行状态传递的同时，扫描函数在引导数组轴上的应用。

scan :: (c -> a -> (c, b)) -> c -> [a] -> (c, [b])

其中对于任何数组类型说明符 t，[t] 表示具有附加引导轴的类型，如果 t 是具有数组叶节点的 pytree（容器）类型，则 [t] 表示具有相同 pytree 结构和相应叶节点的类型，每个叶节点都有一个附加的引导轴。

当 xs 的类型（上面表示为 a）是数组类型或 None，并且 ys 的类型（上面表示为 b）是数组类型时，scan() 的语义大致由以下 Python 实现给出

def scan(f, init, xs, length=None):
  if xs is None:
    xs = [None] * length
  carry = init
  ys = []
  for x in xs:
    carry, y = f(carry, x)
    ys.append(y)
  return carry, np.stack(ys)

与 Python 版本不同，xs 和 ys 都可以是任意 pytree 值，因此可以同时扫描多个数组并生成多个输出数组。None 实际上是这种情况的一个特例，因为它表示一个空的 pytree。

同样与 Python 版本不同，scan() 是一个 JAX 原语，它被降低为一个 WhileOp。这使其对于减少 JIT 编译函数的编译时间非常有用，因为 jit() 函数中的原生 Python 循环结构会被展开，从而导致大型 XLA 计算。

最后，循环携带值 carry 必须在所有迭代中保持固定的形状和 dtype（而不仅仅是在 NumPy 秩/形状广播和 dtype 提升规则方面保持一致）。换句话说，上面类型签名中的类型 c 表示具有固定形状和 dtype 的数组（或具有固定结构和叶节点上具有固定形状和 dtype 的数组的嵌套元组/列表/字典容器数据结构）。

注意

scan() 编译 f，因此虽然它可以与 jit() 结合使用，但通常是不必要的。

注意

scan() 旨在用于静态迭代次数的迭代。对于动态迭代次数的迭代，请使用 fori_loop() 或 while_loop()。

参数:

f (Callable[[Carry, X], tuple[Carry, Y]]) – 要扫描的 Python 函数，类型为 c -> a -> (c, b)，这意味着 f 接受两个参数，第一个是循环携带值，第二个是 xs 沿其引导轴的切片，并且 f 返回一对，其中第一个元素表示循环携带值的新值，第二个元素表示输出的切片。
init (Carry) – 初始循环携带值，类型为 c，可以是标量、数组或任何 pytree（嵌套的 Python 元组/列表/字典），表示初始循环携带值。此值必须与 f 返回的对的第一个元素具有相同的结构。
xs (X | None) – 要沿引导轴扫描的值，类型为 [a]，其中 [a] 可以是数组或任何 pytree（嵌套的 Python 元组/列表/字典），且具有一致的引导轴大小。
length (int | None) – 可选整数，指定循环迭代次数，必须与 xs 中数组的引导轴大小一致（但可以用于执行不需要输入 xs 的扫描）。
reverse (bool) – 可选布尔值，指定是向前运行扫描迭代（默认）还是反向运行，相当于反转 xs 和 ys 中数组的引导轴。
unroll (int | bool) – 可选正整数或布尔值，用于指定扫描原语的底层操作中，在循环的单次迭代中展开多少次扫描迭代。如果提供整数，则确定在循环的单个滚动迭代中运行多少次展开的循环迭代。如果提供布尔值，则确定循环是完全展开（即 unroll=True）还是完全滚动（即 unroll=False）。
_split_transpose (bool) – 实验性可选布尔值，指定是否进一步将转置拆分为扫描（计算激活梯度）和映射（计算与数组参数对应的梯度）。启用此功能可能会增加内存需求，因此是一个实验性功能，可能会演变甚至回滚。

返回:

类型为 (c, [b]) 的一对，其中第一个元素表示最终循环携带值，第二个元素表示扫描输入引导轴时 f 的第二个输出的堆叠输出。

返回类型:

tuple[Carry, Y]

jax.lax.scan

目录

jax.lax.scan#