jax.lax.fori_loop

jax.lax.fori_loop(lower, upper, body_fun, init_val, *, unroll=None)

通过归约到 jax.lax.while_loop() 的方式从 lower 循环到 upper。

Haskell 风格的类型签名简述为

fori_loop :: Int -> Int -> ((Int, a) -> a) -> a -> a

fori_loop 的语义由以下 Python 实现给出

def fori_loop(lower, upper, body_fun, init_val):
  val = init_val
  for i in range(lower, upper):
    val = body_fun(i, val)
  return val

正如 Python 版本所示，设置 upper <= lower 将不会产生迭代。不支持负数或自定义增量。

与 Python 版本不同，fori_loop 是通过调用 jax.lax.while_loop() 或调用 jax.lax.scan() 实现的。如果行程计数是静态的（意味着在 tracing 时已知，可能是因为 lower 和 upper 是 Python 整数文字），那么 fori_loop 是通过 scan() 实现的，并且支持反向模式自动微分；否则，将使用 while_loop，并且不支持反向模式自动微分。有关更多信息，请参阅这些函数的文档字符串。

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

注意

fori_loop() 编译 body_fun，所以虽然它可以与 jit() 结合使用，但通常是不必要的。

参数:

• lower – 表示循环索引下界（包含）的整数

• upper – 表示循环索引上界（不包含）的整数

• body_fun – 类型为 (int, a) -> a 的函数。

• init_val – 类型为 a 的初始循环携带值。

• unroll (int | bool | None) – 一个可选的整数或布尔值，用于确定循环的展开程度。如果提供整数，则确定在循环的单个滚动迭代中运行多少次展开的循环迭代。如果提供布尔值，则确定循环是完全展开（即 unroll=True）还是完全不展开（即 unroll=False）。此参数仅在循环边界静态已知时适用。

返回:

来自最后一次迭代的循环值，类型为 a。