jax.jit#

jax.jit(fun, /, *, in_shardings=UnspecifiedValue, out_shardings=UnspecifiedValue, static_argnums=None, static_argnames=None, donate_argnums=None, donate_argnames=None, keep_unused=False, device=None, backend=None, inline=False, abstracted_axes=None, compiler_options=None)[源]#

使用 XLA 为 fun 设置即时编译。

参数:

  • fun (可调用对象) –

    待即时编译的函数。fun 应是一个纯函数。

    fun 的参数和返回值应为数组、标量或它们的（嵌套）标准 Python 容器（元组/列表/字典）。由 static_argnums 指示的位置参数可以是任何可哈希类型。静态参数作为编译缓存键的一部分，因此必须定义哈希和相等运算符。JAX 会保留对 fun 的弱引用作为编译缓存键，因此 fun 对象必须是弱引用可用的。

  • in_shardings (Any) – 可选，一个 Sharding 或具有 Sharding 叶子节点且其结构是 fun 位置参数元组的树前缀的 pytree。如果提供，传递给 fun 的位置参数的分片必须与 in_shardings 兼容，否则会引发错误；编译后的计算将具有与 in_shardings 对应的输入分片。如果未提供，编译后的计算的输入分片将从参数分片推断。

  • out_shardings (Any) – 可选，一个 Sharding 或具有 Sharding 叶子节点且其结构是 fun 输出的树前缀的 pytree。如果提供，它具有与将相应的 jax.lax.with_sharding_constraint`s 应用于 ``fun`() 的输出相同的效果。

  • static_argnums (int | Sequence[int] | None) –

    可选，一个整数或整数集合，用于指定哪些位置参数应被视为静态（跟踪时和编译时常量）。

    静态参数应是可哈希的，意味着需要实现 __hash__ 和 __eq__，并且是不可变的。否则，它们可以是任意 Python 对象。使用这些常量不同的值调用即时编译函数将触发重新编译。非类数组或其容器的参数必须标记为静态。

    如果既未提供 static_argnums 也未提供 static_argnames，则没有参数被视为静态。如果未提供 static_argnums 但提供了 static_argnames，反之亦然，JAX 会使用 inspect.signature(fun) 来查找与 static_argnames 对应的任何位置参数（或反之亦然）。如果同时提供 static_argnums 和 static_argnames，则不使用 inspect.signature，并且只有列在 static_argnums 或 static_argnames 中的实际参数才会被视为静态。

  • static_argnames (str | Iterable[str] | None) – 可选，一个字符串或字符串集合，指定哪些命名参数应被视为静态（编译时常量）。有关详细信息，请参阅关于 static_argnums 的注释。如果未提供但设置了 static_argnums，则默认值基于调用 inspect.signature(fun) 来查找相应的命名参数。

  • donate_argnums (int | Sequence[int] | None) –

    可选，整数集合，用于指定哪些位置参数缓冲区可以被计算覆盖并在调用者中标记为已删除。一旦计算开始，如果您不再需要参数缓冲区，则可以安全地捐赠它们。在某些情况下，XLA 可以利用捐赠的缓冲区来减少执行计算所需的内存量，例如回收您的一个输入缓冲区来存储结果。您不应重用捐赠给计算的缓冲区；如果您尝试这样做，JAX 将引发错误。默认情况下，不捐赠任何参数缓冲区。

    如果既未提供 donate_argnums 也未提供 donate_argnames，则不捐赠任何参数。如果未提供 donate_argnums 但提供了 donate_argnames，反之亦然，JAX 会使用 inspect.signature(fun) 来查找与 donate_argnames 对应的任何位置参数（或反之亦然）。如果同时提供 donate_argnums 和 donate_argnames，则不使用 inspect.signature，并且只有列在 donate_argnums 或 donate_argnames 中的实际参数才会被捐赠。

    有关缓冲区捐赠的更多详细信息，请参阅 FAQ。

  • donate_argnames (str | Iterable[str] | None) – 可选，一个字符串或字符串集合，指定哪些命名参数捐赠给计算。有关详细信息，请参阅关于 donate_argnums 的注释。如果未提供但设置了 donate_argnums，则默认值基于调用 inspect.signature(fun) 来查找相应的命名参数。

  • keep_unused (bool) – 可选布尔值。如果为 False（默认值），JAX 确定 fun 未使用的参数*可能*会从生成的编译后的 XLA 可执行文件中删除。此类参数将不会传输到设备，也不会提供给底层可执行文件。如果为 True，未使用的参数将不会被剪枝。

  • device (xc.Device | None) – 这是一个实验性功能，其 API 可能会发生变化。可选，即时编译函数将运行的设备。（可通过 jax.devices() 检索可用设备。）默认值继承自 XLA 的 DeviceAssignment 逻辑，通常是使用 jax.devices()[0]。

  • backend (str | None) – 这是一个实验性功能，其 API 可能会发生变化。可选，一个表示 XLA 后端的字符串：'cpu'、'gpu' 或 'tpu'。

  • inline (bool) – 可选布尔值。指定此函数是否应内联到封闭的 jaxprs 中。默认为 False。

  • abstracted_axes (Any | None)

  • compiler_options (dict[str, Any] | None)

返回:

fun 的包装版本，已设置为即时编译。

返回类型:

pjit.JitWrapped

示例

在以下示例中，selu 可以被 XLA 编译成一个单一的融合内核

>>> import jax
>>>
>>> @jax.jit
... def selu(x, alpha=1.67, lmbda=1.05):
...   return lmbda * jax.numpy.where(x > 0, x, alpha * jax.numpy.exp(x) - alpha)
>>>
>>> key = jax.random.key(0)
>>> x = jax.random.normal(key, (10,))
>>> print(selu(x))  
[-0.54485  0.27744 -0.29255 -0.91421 -0.62452 -0.24748
-0.85743 -0.78232  0.76827  0.59566 ]

在装饰函数时传递 static_argnames 等参数时，常见模式是使用 functools.partial()

>>> from functools import partial
>>>
>>> @partial(jax.jit, static_argnames=['n'])
... def g(x, n):
...   for i in range(n):
...     x = x ** 2
...   return x
>>>
>>> g(jnp.arange(4), 3)
Array([   0,    1,  256, 6561], dtype=int32)