网格和 BlockSpec#
grid
,又名循环中的内核#
当使用 jax.experimental.pallas.pallas_call()
时,内核函数会在不同的输入上执行多次,这通过 pallas_call
的 grid
参数指定。概念上
pl.pallas_call(some_kernel, grid=(n,))(...)
映射到
for i in range(n):
some_kernel(...)
网格可以推广到多维,对应于嵌套循环。例如,
pl.pallas_call(some_kernel, grid=(n, m))(...)
等价于
for i in range(n):
for j in range(m):
some_kernel(...)
这可以推广到任何整数元组(长度为 d
的网格将对应于 d
个嵌套循环)。内核的执行次数为 prod(grid)
。默认网格值 ()
导致一次内核调用。这些调用中的每一个都称为“程序”。要访问内核当前正在执行哪个程序(即网格的哪个元素),我们使用 jax.experimental.pallas.program_id()
。例如,对于调用 (1, 2)
,program_id(axis=0)
返回 1
,program_id(axis=1)
返回 2
。您还可以使用 jax.experimental.pallas.num_programs()
来获取给定轴的网格大小。
有关使用此 API 的简单内核,请参阅 网格示例。
BlockSpec
,又名如何分块输入#
结合 grid
参数,我们需要为 Pallas 提供有关如何为每次调用切分输入的信息。具体来说,我们需要提供循环迭代到要操作的输入和输出的哪个块之间的映射。这是通过 jax.experimental.pallas.BlockSpec
对象提供的。
在我们深入了解 BlockSpec
的细节之前,您可能需要回顾一下 Pallas 快速入门中的 块规范示例。
BlockSpec
通过 in_specs
和 out_specs
提供给 pallas_call
,每个输入和输出分别对应一个。
首先,我们讨论 indexing_mode == pl.Blocked()
时 BlockSpec
的语义。
非正式地说,BlockSpec
的 index_map
以调用索引(与 grid
元组的长度相同)作为参数,并返回块索引(每个总体数组轴一个块索引)。然后,每个块索引乘以来自 block_shape
的相应轴大小,以获得相应数组轴上的实际元素索引。
注意
并非所有块形状都受支持。
在 TPU 上,仅支持秩至少为 1 的块。此外,块形状的最后两个维度必须等于总体数组的相应维度,或者分别能被 8 和 128 整除。对于秩为 1 的块,块维度必须等于数组维度,或者能被
128 * (32 / bitwidth(dtype))
整除。在 GPU 上,块本身的大小没有限制,但每个操作都必须在大小为 2 的幂的数组上进行操作。
如果块形状不能均匀地分割整体形状,则每个轴上的最后一次迭代仍将收到对 block_shape
块的引用,但越界的元素将在输入时填充并在输出时丢弃。填充值未指定,您应该假设它们是垃圾。在 interpret=True
模式下,我们使用 NaN 填充浮点值,让用户有机会发现访问越界元素,但不应依赖此行为。请注意,每个块中必须至少有一个元素在边界内。
更准确地说,形状为 x_shape
的输入 x
的每个轴的切片计算方式如下面的函数 slice_for_invocation
中所示
>>> import jax
>>> from jax.experimental import pallas as pl
>>> def slices_for_invocation(x_shape: tuple[int, ...],
... x_spec: pl.BlockSpec,
... grid: tuple[int, ...],
... invocation_indices: tuple[int, ...]) -> tuple[slice, ...]:
... assert len(invocation_indices) == len(grid)
... assert all(0 <= i < grid_size for i, grid_size in zip(invocation_indices, grid))
... block_indices = x_spec.index_map(*invocation_indices)
... assert len(x_shape) == len(x_spec.block_shape) == len(block_indices)
... elem_indices = []
... for x_size, block_size, block_idx in zip(x_shape, x_spec.block_shape, block_indices):
... start_idx = block_idx * block_size
... # At least one element of the block must be within bounds
... assert start_idx < x_size
... elem_indices.append(slice(start_idx, start_idx + block_size))
... return elem_indices
例如
>>> slices_for_invocation(x_shape=(100, 100),
... x_spec = pl.BlockSpec((10, 20), lambda i, j: (i, j)),
... grid = (10, 5),
... invocation_indices = (2, 4))
[slice(20, 30, None), slice(80, 100, None)]
>>> # Same shape of the array and blocks, but we iterate over each block 4 times
>>> slices_for_invocation(x_shape=(100, 100),
... x_spec = pl.BlockSpec((10, 20), lambda i, j, k: (i, j)),
... grid = (10, 5, 4),
... invocation_indices = (2, 4, 0))
[slice(20, 30, None), slice(80, 100, None)]
>>> # An example when the block is partially out-of-bounds in the 2nd axis.
>>> slices_for_invocation(x_shape=(100, 90),
... x_spec = pl.BlockSpec((10, 20), lambda i, j: (i, j)),
... grid = (10, 5),
... invocation_indices = (2, 4))
[slice(20, 30, None), slice(80, 100, None)]
下面定义的函数 show_program_ids
使用 Pallas 来显示调用索引。iota_2D_kernel
将用一个十进制数填充每个输出块,其中第一位数字表示在第一个轴上的调用索引,第二位数字表示在第二个轴上的调用索引
>>> def show_program_ids(x_shape, block_shape, grid,
... index_map=lambda i, j: (i, j),
... indexing_mode=pl.Blocked()):
... def program_ids_kernel(o_ref): # Fill the output block with 10*program_id(1) + program_id(0)
... axes = 0
... for axis in range(len(grid)):
... axes += pl.program_id(axis) * 10**(len(grid) - 1 - axis)
... o_ref[...] = jnp.full(o_ref.shape, axes)
... res = pl.pallas_call(program_ids_kernel,
... out_shape=jax.ShapeDtypeStruct(x_shape, dtype=np.int32),
... grid=grid,
... in_specs=[],
... out_specs=pl.BlockSpec(block_shape, index_map, indexing_mode=indexing_mode),
... interpret=True)()
... print(res)
例如
>>> show_program_ids(x_shape=(8, 6), block_shape=(2, 3), grid=(4, 2),
... index_map=lambda i, j: (i, j))
[[ 0 0 0 1 1 1]
[ 0 0 0 1 1 1]
[10 10 10 11 11 11]
[10 10 10 11 11 11]
[20 20 20 21 21 21]
[20 20 20 21 21 21]
[30 30 30 31 31 31]
[30 30 30 31 31 31]]
>>> # An example with out-of-bounds accesses
>>> show_program_ids(x_shape=(7, 5), block_shape=(2, 3), grid=(4, 2),
... index_map=lambda i, j: (i, j))
[[ 0 0 0 1 1]
[ 0 0 0 1 1]
[10 10 10 11 11]
[10 10 10 11 11]
[20 20 20 21 21]
[20 20 20 21 21]
[30 30 30 31 31]]
>>> # It is allowed for the shape to be smaller than block_shape
>>> show_program_ids(x_shape=(1, 2), block_shape=(2, 3), grid=(1, 1),
... index_map=lambda i, j: (i, j))
[[0 0]]
当多个调用写入输出数组的相同元素时,结果取决于平台。
在下面的示例中,我们有一个 3D 网格,其中最后一个网格维度未在块选择中使用(index_map=lambda i, j, k: (i, j)
)。因此,我们在同一个输出块上迭代 10 次。下面显示的输出是在 CPU 上使用 interpret=True
模式生成的,该模式目前按顺序执行调用。在 TPU 上,程序以并行和串行的组合方式执行,此函数生成所示的输出。请参阅 值得注意的属性和限制。
>>> show_program_ids(x_shape=(8, 6), block_shape=(2, 3), grid=(4, 2, 10),
... index_map=lambda i, j, k: (i, j))
[[ 9 9 9 19 19 19]
[ 9 9 9 19 19 19]
[109 109 109 119 119 119]
[109 109 109 119 119 119]
[209 209 209 219 219 219]
[209 209 209 219 219 219]
[309 309 309 319 319 319]
[309 309 309 319 319 319]]
在 block_shape
中作为维度值出现的 None
值的作用类似于值 1
,只不过对应的块轴被挤压。在下面的示例中,观察到当块形状指定为 (None, 2)
时,o_ref
的形状为 (2,) (前导维度被挤压)。
>>> def kernel(o_ref):
... assert o_ref.shape == (2,)
... o_ref[...] = jnp.full((2,), 10 * pl.program_id(1) + pl.program_id(0))
>>> pl.pallas_call(kernel,
... jax.ShapeDtypeStruct((3, 4), dtype=np.int32),
... out_specs=pl.BlockSpec((None, 2), lambda i, j: (i, j)),
... grid=(3, 2), interpret=True)()
Array([[ 0, 0, 10, 10],
[ 1, 1, 11, 11],
[ 2, 2, 12, 12]], dtype=int32)
当我们构造 BlockSpec
时,我们可以为 block_shape
参数使用值 None
,在这种情况下,将使用整体数组的形状作为 block_shape
。如果我们为 index_map
参数使用值 None
,则将使用返回零元组的默认索引映射函数:index_map=lambda *invocation_indices: (0,) * len(block_shape)
。
>>> show_program_ids(x_shape=(4, 4), block_shape=None, grid=(2, 3),
... index_map=None)
[[12 12 12 12]
[12 12 12 12]
[12 12 12 12]
[12 12 12 12]]
>>> show_program_ids(x_shape=(4, 4), block_shape=(4, 4), grid=(2, 3),
... index_map=None)
[[12 12 12 12]
[12 12 12 12]
[12 12 12 12]
[12 12 12 12]]
“未分块”索引模式#
上面记录的行为适用于 indexing_mode=pl.Blocked()
。当使用 pl.Unblocked
索引模式时,索引映射函数返回的值直接用作数组索引,而无需先按块大小缩放它们。当使用未分块模式时,您可以为每个维度指定低-高填充的元组来虚拟填充数组:行为就好像整体数组在输入时被填充。未分块模式下的填充值不做任何保证,类似于当块形状不能分割整体数组形状时,分块索引模式下的填充值。
未分块模式目前仅在 TPU 上受支持。
>>> # unblocked without padding
>>> show_program_ids(x_shape=(8, 6), block_shape=(2, 3), grid=(4, 2),
... index_map=lambda i, j: (2*i, 3*j),
... indexing_mode=pl.Unblocked())
[[ 0 0 0 1 1 1]
[ 0 0 0 1 1 1]
[10 10 10 11 11 11]
[10 10 10 11 11 11]
[20 20 20 21 21 21]
[20 20 20 21 21 21]
[30 30 30 31 31 31]
[30 30 30 31 31 31]]
>>> # unblocked, first pad the array with 1 row and 2 columns.
>>> show_program_ids(x_shape=(7, 7), block_shape=(2, 3), grid=(4, 3),
... index_map=lambda i, j: (2*i, 3*j),
... indexing_mode=pl.Unblocked(((1, 0), (2, 0))))
[[ 0 1 1 1 2 2 2]
[10 11 11 11 12 12 12]
[10 11 11 11 12 12 12]
[20 21 21 21 22 22 22]
[20 21 21 21 22 22 22]
[30 31 31 31 32 32 32]
[30 31 31 31 32 32 32]]