jax.experimental.pjit 模块#

API#

jax.experimental.pjit.pjit(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)[source]#

使 fun 在多个设备上进行编译并自动分区。

注意：此函数现在等同于 jax.jit，请改用该函数。返回的函数语义上等同于 fun，但它被编译成一个在多个设备（例如多个 GPU 或多个 TPU 核）上运行的 XLA 计算。当 jitted 版本的 fun 无法适应单个设备的内存时，或者通过在多个设备上并行运行每个操作来加速 fun 时，这会很有用。

设备间的分区是根据 in_shardings 中指定的输入分区和 out_shardings 中指定的输出分区的传播自动进行的。这两个参数中指定的资源必须引用网格轴，如 jax.sharding.Mesh() 上下文管理器所定义。请注意，在 pjit() 应用时忽略网格定义，返回的函数将在每个调用点使用可用的网格定义。

如果 pjit() 函数的输入尚未根据 in_shardings 正确分区，它们将自动在设备间分区。在某些情况下，确保输入已正确预分区可以提高性能。例如，如果将一个 pjit() 函数的输出传递给另一个 pjit() 函数（或循环中的同一个 pjit() 函数），请确保相关的 out_shardings 与对应的 in_shardings 匹配。

注意

多进程平台： 在 TPU pod 等多进程平台上，pjit() 可用于跨进程的所有可用设备运行计算。为此，pjit() 被设计用于 SPMD Python 程序，其中每个进程运行相同的 Python 代码，以便所有进程以相同的顺序运行相同的 pjit() 函数。

在此配置下运行时，网格应包含所有进程中的设备。所有输入参数都必须是全局形状的。fun 仍将在网格中所有设备上执行，包括来自其他进程的设备，并将获得一个单一数组形式的跨多个进程分布的数据的全局视图。

SPMD 模型还要求在所有进程上以相同的顺序运行相同的多进程 pjit() 函数，但它们可以与在单个进程中运行的任意操作交错进行。

参数:

  • fun (Callable) – 要编译的函数。应为纯函数，因为副作用可能只执行一次。其参数和返回值应为数组、标量或其（嵌套的）标准Python容器（元组/列表/字典）。由 static_argnums 指定的位置参数可以是任何东西，只要它们是可哈希的并且定义了相等操作。静态参数作为编译缓存键的一部分，这就是为什么必须定义哈希和相等运算符的原因。

  • in_shardings (Any) –

    Pytree 的结构与 fun 的参数结构匹配，所有实际参数都替换为资源分配规范。指定 pytree 前缀（例如，一个值代替整个子树）也是有效的，在这种情况下，叶子会被广播到该子树中的所有值。

    in_shardings 参数是可选的。JAX 将从输入 jax.Array 中推断分片，如果无法推断分片，则默认为复制输入。

    有效的资源分配规范是：

    • Sharding，这将决定值如何分区。使用此选项时，不需要使用网格上下文管理器。

    • None 是一个特殊情况，其语义是：

      • 如果未提供网格上下文管理器，JAX 可以自由选择任何它想要的分片。对于 in_shardings，JAX 会将其标记为已复制，但此行为将来可能会改变。对于 out_shardings，我们将依赖 XLA GSPMD 分区器来确定输出分片。

      • 如果提供了网格上下文管理器，None 将表示该值将在网格的所有设备上复制。

    • 为了向后兼容，in_shardings 仍支持摄取 PartitionSpec。此选项只能与网格上下文管理器一起使用。

      • PartitionSpec，一个长度至多等于分区值的秩的元组。每个元素可以是 None、网格轴或网格轴的元组，并指定分配给分区值维度（与其在规范中的位置匹配）的资源集合。

    每个维度的大小必须是分配给它的资源总数的倍数。

  • out_shardings (Any) – 类似于 in_shardings，但指定函数输出的资源分配。out_shardings 参数是可选的。如果未指定，jax.jit() 将使用 GSPMD 的分片传播来确定如何分片输出。

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

    一个可选的整数或整数集合，用于指定哪些位置参数被视为静态（编译时常量）。仅依赖于静态参数的操作将在 Python 中（在追踪期间）进行常量折叠，因此相应的参数值可以是任何 Python 对象。

    静态参数应该是可哈希的，这意味着实现了 __hash__ 和 __eq__，并且是不可变的。使用不同的常量值调用 jitted 函数将触发重新编译。非数组或非容器的参数必须标记为静态。

    如果未提供 static_argnums，则不将任何参数视为静态。

  • 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) – 此参数已弃用。请在将参数传递给 jit 之前将其放置在所需设备上。可选，jitted 函数将运行的设备。（可用设备可以通过 jax.devices() 获取。）默认继承自 XLA 的 DeviceAssignment 逻辑，通常是使用 jax.devices()[0]。

  • backend (str | None) – 此参数已弃用。请在将参数传递给 jit 之前将其放置在所需后端上。可选，表示 XLA 后端的字符串：'cpu'、'gpu' 或 'tpu'。

  • inline (bool)

  • abstracted_axes (Any | None)

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

返回:

一个 fun 的封装版本，已设置为即时编译，并由每个调用点可用的网格自动分区。

返回类型:

JitWrapped

例如，一个卷积运算符可以通过一次 pjit() 应用自动在任意设备集上分区：

>>> import jax
>>> import jax.numpy as jnp
>>> import numpy as np
>>> from jax.sharding import Mesh, PartitionSpec
>>> from jax.experimental.pjit import pjit
>>>
>>> x = jnp.arange(8, dtype=jnp.float32)
>>> f = pjit(lambda x: jax.numpy.convolve(x, jnp.asarray([0.5, 1.0, 0.5]), 'same'),
...         in_shardings=None, out_shardings=PartitionSpec('devices'))
>>> with Mesh(np.array(jax.devices()), ('devices',)):
...   print(f(x))  
[ 0.5  2.   4.   6.   8.  10.  12.  10. ]