jax.lax 模块#

jax.lax 是一个原语操作库，它是 jax.numpy 等库的基础。转换规则，例如 JVP 和批处理规则，通常被定义为对 jax.lax 原语的转换。

许多原语是对等效 XLA 操作的薄封装，这些操作在 XLA 操作语义文档中描述。在少数情况下，JAX 会偏离 XLA，通常是为了确保操作集在 JVP 和转置规则的操作下是闭合的。

在可能的情况下，请优先使用 jax.numpy 等库，而不是直接使用 jax.lax。 jax.numpy API 遵循 NumPy，因此比 jax.lax API 更稳定且更不易更改。

运算符#

abs(x)

逐元素绝对值：\(|x|\)。

acos(x)

逐元素反余弦：\(\mathrm{acos}(x)\)。

acosh(x)

逐元素反双曲余弦：\(\mathrm{acosh}(x)\)。

add(x, y)

逐元素加法：\(x + y\)。

after_all(*operands)

合并一个或多个 XLA 令牌值。

approx_max_k(operand, k[, ...])

以近似方式返回 operand 的最大 k 个值及其索引。

approx_min_k(operand, k[, ...])

以近似方式返回 operand 的最小 k 个值及其索引。

argmax(operand, axis, index_dtype)

计算沿 axis 的最大元素的索引。

argmin(operand, axis, index_dtype)

计算沿 axis 的最小元素的索引。

asin(x)

逐元素反正弦：\(\mathrm{asin}(x)\)。

asinh(x)

逐元素反双曲正弦：\(\mathrm{asinh}(x)\)。

atan(x)

逐元素反正切：\(\mathrm{atan}(x)\)。

atan2(x, y)

逐元素双参数反正切：\(\mathrm{atan}({x \over y})\)。

atanh(x)

逐元素反双曲正切：\(\mathrm{atanh}(x)\)。

batch_matmul(lhs, rhs[, precision])

批量矩阵乘法。

bessel_i0e(x)

指数缩放的 0 阶修正贝塞尔函数：\(\mathrm{i0e}(x) = e^{-|x|} \mathrm{i0}(x)\)

bessel_i1e(x)

指数缩放的 1 阶修正贝塞尔函数：\(\mathrm{i1e}(x) = e^{-|x|} \mathrm{i1}(x)\)

betainc(a, b, x)

逐元素正则不完全贝塔积分。

bitcast_convert_type(operand, new_dtype)

逐元素位播。

bitwise_and(x, y)

逐元素与：\(x \wedge y\)。

bitwise_not(x)

逐元素非：\(\neg x\)。

bitwise_or(x, y)

逐元素或：\(x \vee y\)。

bitwise_xor(x, y)

逐元素异或：\(x \oplus y\)。

population_count(x)

逐元素 population count，计算每个元素中设置的位数。

broadcast(operand, sizes, *[, out_sharding])

广播数组，添加新的前导维度

broadcast_in_dim(operand, shape, ...[, ...])

包装 XLA 的 BroadcastInDim 运算符。

broadcast_shapes(*shapes)

返回 NumPy 广播 shapes 产生的形状。

broadcast_to_rank(x, rank)

添加 1 的前导维度，使 x 的秩为 rank。

broadcasted_iota(dtype, shape, dimension, *)

iota 的便捷包装器。

cbrt(x[, accuracy])

逐元素立方根：\(\sqrt[3]{x}\)。

ceil(x)

逐元素向上取整：\(\left\lceil x \right\rceil\)。

clamp(min, x, max)

逐元素夹紧。

clz(x)

逐元素前导零计数。

collapse(operand, start_dimension[, ...])

将数组的维度折叠成单个维度。

complex(x, y)

逐元素创建复数：\(x + jy\)。

composite(decomposition, name[, version])

语义由分解函数定义的 Composite。

concatenate(operands, dimension)

沿 dimension 连接一系列数组。

conj(x)

逐元素复共轭函数：\(\overline{x}\)。

conv(lhs, rhs, window_strides, padding[, ...])

conv_general_dilated 的便捷包装器。

convert_element_type(operand, new_dtype)

逐元素类型转换。

conv_dimension_numbers(lhs_shape, rhs_shape, ...)

将卷积 dimension_numbers 转换为 ConvDimensionNumbers。

conv_general_dilated(lhs, rhs, ...[, ...])

通用 n 维卷积运算符，具有可选的空洞。

conv_general_dilated_local(lhs, rhs, ...[, ...])

通用 n 维非共享卷积运算符，具有可选的空洞。

conv_general_dilated_patches(lhs, ...[, ...])

提取受 conv_general_dilated 感受野约束的补丁。

conv_transpose(lhs, rhs, strides, padding[, ...])

用于计算 N 维卷积“转置”的便捷包装器。

conv_with_general_padding(lhs, rhs, ...[, ...])

conv_general_dilated 的便捷包装器。

cos(x[, accuracy])

逐元素余弦：\(\mathrm{cos}(x)\)。

cosh(x)

逐元素双曲余弦：\(\mathrm{cosh}(x)\)。

cumlogsumexp(operand[, axis, reverse])

计算沿 axis 的累积 logsumexp。

cummax(operand[, axis, reverse])

计算沿 axis 的累积最大值。

cummin(operand[, axis, reverse])

计算沿 axis 的累积最小值。

cumprod(operand[, axis, reverse])

计算沿 axis 的累积积。

cumsum(operand[, axis, reverse])

计算沿 axis 的累积和。

digamma(x)

逐元素 digamma：\(\psi(x)\)。

div(x, y)

逐元素除法：\(x \over y\)。

dot(lhs, rhs[, precision, ...])

向量/向量、矩阵/向量和矩阵/矩阵乘法。

dot_general(lhs, rhs, dimension_numbers[, ...])

通用点积/缩并运算符。

dynamic_index_in_dim(operand, index[, axis, ...])

dynamic_slice 的便捷包装器，用于执行整数索引。

dynamic_slice(operand, start_indices, ...[, ...])

包装 XLA 的 DynamicSlice 运算符。

dynamic_slice_in_dim(operand, start_index, ...)

lax.dynamic_slice() 的便捷包装器，应用于一个维度。

dynamic_update_index_in_dim(operand, update, ...)

dynamic_update_slice() 的便捷包装器，用于更新单个 axis 中大小为 1 的切片。

dynamic_update_slice(operand, update, ...[, ...])

包装 XLA 的 DynamicUpdateSlice 运算符。

dynamic_update_slice_in_dim(operand, update, ...)

dynamic_update_slice() 的便捷包装器，用于更新单个 axis 中的切片。

eq(x, y)

逐元素等于：\(x = y\)。

erf(x)

逐元素误差函数：\(\mathrm{erf}(x)\)。

erfc(x)

逐元素互补误差函数：\(\mathrm{erfc}(x) = 1 - \mathrm{erf}(x)\)。

erf_inv(x)

逐元素逆误差函数：\(\mathrm{erf}^{-1}(x)\)。

exp(x[, accuracy])

逐元素指数：\(e^x\)。

exp2(x[, accuracy])

逐元素以 2 为底的指数：\(2^x\)。

expand_dims(array, dimensions)

在数组中插入任意数量的大小为 1 的维度。

expm1(x[, accuracy])

逐元素 \(e^{x} - 1\)。

fft(x, fft_type, fft_lengths)

floor(x)

逐元素向下取整：\(\left\lfloor x \right\rfloor\)。

full(shape, fill_value[, dtype, sharding])

返回填充了 fill_value 的 shape 数组。

full_like(x, fill_value[, dtype, shape, ...])

基于示例数组 x 创建类似 np.full 的完整数组。

gather(operand, start_indices, ...[, ...])

Gather 操作符。

ge(x, y)

逐元素大于等于：\(x \geq y\)。

gt(x, y)

逐元素大于：\(x > y\)。

igamma(a, x)

逐元素正则化不完全伽玛函数。

igammac(a, x)

逐元素互补正则化不完全伽玛函数。

imag(x)

逐元素提取虚部：\(\mathrm{Im}(x)\)。

index_in_dim(operand, index[, axis, keepdims])

lax.slice() 的便捷包装器，用于执行整数索引。

index_take(src, idxs, axes)

integer_pow(x, y)

逐元素幂运算：\(x^y\)，其中 \(y\) 是一个静态整数。

iota(dtype, size)

包装了 XLA 的 Iota 操作符。

is_finite(x)

逐元素 \(\mathrm{isfinite}\)。

le(x, y)

逐元素小于等于：\(x \leq y\)。

lgamma(x)

逐元素 log 伽玛函数：\(\mathrm{log}(\Gamma(x))\)。

log(x[, accuracy])

逐元素自然对数：\(\mathrm{log}(x)\)。

log1p(x[, accuracy])

逐元素 \(\mathrm{log}(1 + x)\)。

logistic(x[, accuracy])

逐元素 logistic（sigmoid）函数：\(\frac{1}{1 + e^{-x}}\)。

lt(x, y)

逐元素小于：\(x < y\)。

max(x, y)

逐元素最大值：\(\mathrm{max}(x, y)\)。

min(x, y)

逐元素最小值：\(\mathrm{min}(x, y)\)

mul(x, y)

逐元素乘法：\(x \times y\)。

ne(x, y)

逐元素不等于：\(x \neq y\)。

neg(x)

逐元素取反：\(-x\)。

nextafter(x1, x2)

返回 x1 之后在 x2 方向上的下一个可表示值。

optimization_barrier(operand, /)

阻止编译器跨越 barrier 移动操作。

pad(operand, padding_value, padding_config)

对数组应用低、高和/或内部填充。

platform_dependent(*args[, default])

分阶段输出特定于平台代码。

polygamma(m, x)

逐元素多伽玛函数：\(\psi^{(m)}(x)\)。

population_count(x)

逐元素 population count，计算每个元素中设置的位数。

pow(x, y)

逐元素幂运算：\(x^y\)。

random_gamma_grad(*args)

real(x)

逐元素提取实部：\(\mathrm{Re}(x)\)。

reciprocal(x)

逐元素倒数：\(1 \over x\)。

reduce(operands, init_values, computation, ...)

包装了 XLA 的 Reduce 操作符。

reduce_and(operand, axes)

计算一个或多个数组轴上元素的按位 AND。

reduce_max(operand, axes)

计算一个或多个数组轴上元素的最大值。

reduce_min(operand, axes)

计算一个或多个数组轴上元素的最小值。

reduce_or(operand, axes)

计算一个或多个数组轴上元素的按位 OR。

reduce_precision(operand, exponent_bits, ...)

包装了 XLA 的 ReducePrecision 操作符。

reduce_prod(operand, axes)

计算一个或多个数组轴上元素的乘积。

reduce_sum(operand, axes)

计算一个或多个数组轴上元素的总和。

reduce_window(operand, init_value, ...[, ...])

包装了 XLA 的 ReduceWindowWithGeneralPadding 操作符。

reduce_xor(operand, axes)

计算一个或多个数组轴上元素的按位 XOR。

rem(x, y)

逐元素余数：\(x \bmod y\)。

reshape(operand, new_sizes[, dimensions, ...])

包装了 XLA 的 Reshape 操作符。

rev(operand, dimensions)

包装了 XLA 的 Rev 操作符。

rng_bit_generator(key, shape[, dtype, ...])

无状态 PRNG 位生成器。

rng_uniform(a, b, shape)

有状态 PRNG 生成器。

round(x[, rounding_method])

逐元素四舍五入。

rsqrt(x[, accuracy])

逐元素倒数平方根：\(1 \over \sqrt{x}\)。

scatter(operand, scatter_indices, updates, ...)

Scatter-update 操作符。

scatter_add(operand, scatter_indices, ...[, ...])

Scatter-add 操作符。

scatter_apply(operand, scatter_indices, ...)

Scatter-apply 操作符。

scatter_max(operand, scatter_indices, ...[, ...])

Scatter-max 操作符。

scatter_min(operand, scatter_indices, ...[, ...])

Scatter-min 操作符。

scatter_mul(operand, scatter_indices, ...[, ...])

Scatter-multiply 操作符。

shift_left(x, y)

逐元素左移：\(x \ll y\)。

shift_right_arithmetic(x, y)

逐元素算术右移：\(x \gg y\)。

shift_right_logical(x, y)

逐元素逻辑右移：\(x \gg y\)。

sign(x)

逐元素符号函数。

sin(x[, accuracy])

逐元素正弦：\(\mathrm{sin}(x)\)。

sinh(x)

逐元素双曲正弦：\(\mathrm{sinh}(x)\)。

slice(operand, start_indices, limit_indices)

包装了 XLA 的 Slice 操作符。

slice_in_dim(operand, start_index, limit_index)

lax.slice() 的便捷包装器，仅应用于一个维度。

sort()

包装了 XLA 的 Sort 操作符。

sort_key_val(keys, values[, dimension, ...])

沿 dimension 对 keys 进行排序，并将相同的排列应用于 values。

split(operand, sizes[, axis])

沿 axis 拆分数组。

sqrt(x[, accuracy])

逐元素平方根：\(\sqrt{x}\)。

square(x)

逐元素平方：\(x^2\)。

squeeze(array, dimensions)

从数组中挤压任意数量的大小为 1 的维度。

sub(x, y)

逐元素减法：\(x - y\)。

tan(x[, accuracy])

逐元素正切：\(\mathrm{tan}(x)\)。

tanh(x[, accuracy])

逐元素双曲正切：\(\mathrm{tanh}(x)\)。

top_k(operand, k)

返回 operand 最后一个轴上的前 k 个值及其索引。

transpose(operand, permutation)

包装了 XLA 的 Transpose 操作符。

zeros_like_array(x)

zeta(x, q)

逐元素 Hurwitz zeta 函数：\(\zeta(x, q)\)

控制流操作符#

associative_scan(fn, elems[, reverse, axis])

使用结合二元运算并行执行扫描。

cond(pred, true_fun, false_fun, *operands[, ...])

有条件地应用 true_fun 或 false_fun。

fori_loop(lower, upper, body_fun, init_val, *)

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

map(f, xs, *[, batch_size])

在先导数组轴上映射函数。

scan(f, init[, xs, length, reverse, unroll, ...])

在先导数组轴上扫描函数，同时携带状态。

select(pred, on_true, on_false)

根据布尔谓词在两个分支之间进行选择。

select_n(which, *cases)

从多个 cases 中选择数组值。

switch(index, branches, *operands[, operand])

应用由 index 给出的 branches 中的恰好一个。

while_loop(cond_fun, body_fun, init_val)

当 cond_fun 为 True 时，重复调用循环中的 body_fun。

自定义梯度操作符#

stop_gradient(x)

停止梯度计算。

custom_linear_solve(matvec, b, solve[, ...])

执行具有隐式定义梯度的无矩阵线性求解。

custom_root(f, initial_guess, solve, ...[, ...])

可微地求解函数的根。

并行操作符#

all_gather(x, axis_name, *[, ...])

跨所有副本收集 x 的值。

all_to_all(x, axis_name, split_axis, ...[, ...])

物化映射轴并映射不同的轴。

psum(x, axis_name, *[, axis_index_groups])

在 pmapped 轴 axis_name 上计算 x 的 all-reduce 总和。

psum_scatter(x, axis_name, *[, ...])

类似于 psum(x, axis_name)，但每个设备仅保留部分结果。

pmax(x, axis_name, *[, axis_index_groups])

在 pmapped 轴 axis_name 上计算 x 的 all-reduce 最大值。

pmin(x, axis_name, *[, axis_index_groups])

在 pmapped 轴 axis_name 上计算 x 的 all-reduce 最小值。

pmean(x, axis_name, *[, axis_index_groups])

在 pmapped 轴 axis_name 上计算 x 的 all-reduce 均值。

ppermute(x, axis_name, perm)

根据排列 perm 执行集体排列。

pshuffle(x, axis_name, perm)

jax.lax.ppermute 的便捷包装器，具有备用排列编码

pswapaxes(x, axis_name, axis, *[, ...])

将 pmapped 轴 axis_name 与未映射轴 axis 交换。

axis_index(axis_name)

返回沿映射轴 axis_name 的索引。

axis_size(axis_name)

返回映射轴 axis_name 的大小。

线性代数操作符 (jax.lax.linalg)#

cholesky(x, *[, symmetrize_input])

Cholesky 分解。

cholesky_update(r_matrix, w_vector)

Cholesky 秩 1 更新。

eig(x, *[, compute_left_eigenvectors, ...])

一般矩阵的特征分解。

eigh(x, *[, lower, symmetrize_input, ...])

Hermitian 矩阵的特征分解。

hessenberg(a)

将方阵简化为上 Hessenberg 形式。

householder_product(a, taus)

初等 Householder 反射器的乘积。

lu(x)

具有部分旋转的 LU 分解。

lu_pivots_to_permutation(pivots, ...)

将 LU 返回的 pivots（行交换）转换为排列。

qdwh(x, *[, is_hermitian, max_iterations, ...])

基于 QR 的动态加权 Halley 迭代，用于极分解。

qr()

QR 分解。

schur(x, *[, compute_schur_vectors, ...])

Schur 分解。

svd()

奇异值分解。

SvdAlgorithm(value)

SVD 算法的枚举。

symmetric_product(a_matrix, c_matrix, *[, ...])

对称积。

triangular_solve(a, b, *[, left_side, ...])

三角求解。

tridiagonal(a, *[, lower])

将对称/Hermitian 矩阵简化为三对角形式。

tridiagonal_solve(dl, d, du, b)

计算三对角线性系统的解。

参数类#

class jax.lax.ConvDimensionNumbers(lhs_spec, rhs_spec, out_spec)[source]#

描述卷积的批次、空间和特征维度。

参数:

  • lhs_spec (Sequence[int]) – 一个非负整数维度编号的元组，包含 (批次维度, 特征维度, 空间维度…)。

  • rhs_spec (Sequence[int]) – 一个非负整数维度编号的元组，包含 (输出特征维度, 输入特征维度, 空间维度…)。

  • out_spec (Sequence[int]) – 一个非负整数维度编号的元组，包含 (批次维度, 特征维度, 空间维度…)。

jax.lax.ConvGeneralDilatedDimensionNumbers#

别名： tuple[str, str, str] | ConvDimensionNumbers | None

class jax.lax.DotAlgorithm(lhs_precision_type, rhs_precision_type, accumulation_type, lhs_component_count=1, rhs_component_count=1, num_primitive_operations=1, allow_imprecise_accumulation=False)[source]#

指定用于计算点积的算法。

当用于指定 precision 输入到 dot(), dot_general() 和其他点积函数时，此数据结构用于控制用于计算点积的算法的属性。此 API 控制用于计算的精度，并允许用户访问硬件特定的加速。

对这些算法的支持取决于平台，并且使用不受支持的算法将在编译计算时引发 Python 异常。至少在某些平台上已知支持的算法在 DotAlgorithmPreset 枚举中列出，这些是试验此 API 的良好起点。

“点积算法”由以下参数指定

  • lhs_precision_type 和 rhs_precision_type，操作的 LHS 和 RHS 四舍五入到的数据类型。

  • accumulation_type 用于累加的数据类型。

  • lhs_component_count，rhs_component_count，和 num_primitive_operations 应用于将 LHS 和/或 RHS 分解为多个组件并在这些值上执行多个操作的算法，通常是为了模拟更高的精度。对于没有分解的算法，这些值应设置为 1。

  • allow_imprecise_accumulation 用于指定是否允许在某些步骤中进行较低精度的累加 (例如 CUBLASLT_MATMUL_DESC_FAST_ACCUM)。

StableHLO 规范 对于点积操作，不要求精度类型与输入或输出的存储类型相同，但某些平台可能要求这些类型匹配。此外，dot_general() 的返回类型始终由输入算法的 accumulation_type 参数定义（如果已指定）。

示例

使用 32 位浮点累加器累加两个 16 位浮点数

>>> algorithm = DotAlgorithm(
...     lhs_precision_type=np.float16,
...     rhs_precision_type=np.float16,
...     accumulation_type=np.float32,
... )
>>> lhs = jnp.array([1.0, 2.0, 3.0, 4.0], dtype=np.float16)
>>> rhs = jnp.array([1.0, 2.0, 3.0, 4.0], dtype=np.float16)
>>> dot(lhs, rhs, precision=algorithm)  
array([ 1.,  4.,  9., 16.], dtype=float16)

或者，等效地，使用预设

>>> algorithm = DotAlgorithmPreset.F16_F16_F32
>>> dot(lhs, rhs, precision=algorithm)  
array([ 1.,  4.,  9., 16.], dtype=float16)

预设也可以按名称指定

>>> dot(lhs, rhs, precision="F16_F16_F32")  
array([ 1.,  4.,  9., 16.], dtype=float16)

preferred_element_type 参数可用于返回输出，而无需向下转换累加类型

>>> dot(lhs, rhs, precision="F16_F16_F32", preferred_element_type=np.float32)  
array([ 1.,  4.,  9., 16.], dtype=float32)
参数:

  • lhs_precision_type (DTypeLike)

  • rhs_precision_type (DTypeLike)

  • accumulation_type (DTypeLike)

  • lhs_component_count (int)

  • rhs_component_count (int)

  • num_primitive_operations (int)

  • allow_imprecise_accumulation (bool)

class jax.lax.DotAlgorithmPreset(value)[source]#

用于计算点积的已知算法的枚举。

此 Enum 提供了一组命名的 DotAlgorithm 对象，这些对象已知在至少一个平台上受支持。有关这些算法行为的更多详细信息，请参阅 DotAlgorithm 文档。

在调用 dot(), dot_general() 或大多数其他 JAX 点积函数时，可以从此列表中选择一个算法，方法是使用 precision 参数传递此 Enum 的成员或其名称作为字符串。

例如，用户可以直接使用此 Enum 指定预设

>>> lhs = jnp.array([1.0, 2.0, 3.0, 4.0], dtype=np.float16)
>>> rhs = jnp.array([1.0, 2.0, 3.0, 4.0], dtype=np.float16)
>>> algorithm = DotAlgorithmPreset.F16_F16_F32
>>> dot(lhs, rhs, precision=algorithm)  
array([ 1.,  4.,  9., 16.], dtype=float16)

或者，等效地，可以通过名称指定它们

>>> dot(lhs, rhs, precision="F16_F16_F32")  
array([ 1.,  4.,  9., 16.], dtype=float16)

预设的名称通常为 LHS_RHS_ACCUM，其中 LHS 和 RHS 分别是 lhs 和 rhs 输入的元素类型，而 ACCUM 是累加器的元素类型。一些预设有一个额外的后缀，每个后缀的含义在下面文档中说明。支持的预设是

DEFAULT = 1#

将根据输入和输出类型选择算法。

ANY_F8_ANY_F8_F32 = 2#

接受任何 float8 输入类型并累加到 float32。

ANY_F8_ANY_F8_F32_FAST_ACCUM = 3#

类似于 ANY_F8_ANY_F8_F32，但使用更快的累加，但以较低的精度为代价。

ANY_F8_ANY_F8_ANY = 4#

类似于 ANY_F8_ANY_F8_F32，但累加类型由 preferred_element_type 控制。

ANY_F8_ANY_F8_ANY_FAST_ACCUM = 5#

类似于 ANY_F8_ANY_F8_F32_FAST_ACCUM，但累加类型由 preferred_element_type 控制。

F16_F16_F16 = 6#
F16_F16_F32 = 7#
BF16_BF16_BF16 = 8#
BF16_BF16_F32 = 9#
BF16_BF16_F32_X3 = 10#

_X3 后缀表示该算法使用 3 个操作来模拟更高的精度。

BF16_BF16_F32_X6 = 11#

类似于 BF16_BF16_F32_X3，但使用 6 个操作而不是 3 个。

BF16_BF16_F32_X9 = 12#

类似于 BF16_BF16_F32_X3，但使用 9 个操作而不是 3 个。

TF32_TF32_F32 = 13#
TF32_TF32_F32_X3 = 14#

_X3 后缀表示该算法使用 3 个操作来模拟更高的精度。

F32_F32_F32 = 15#
F64_F64_F64 = 16#
property supported_lhs_types: tuple[DTypeLike, ...] | None[source]#
property supported_rhs_types: tuple[DTypeLike, ...] | None[source]#
property accumulation_type: DTypeLike | None[source]#
supported_output_types(lhs_dtype, rhs_dtype)[source]#
参数:

  • lhs_dtype (DTypeLike)

  • rhs_dtype (DTypeLike)

返回类型:

tuple[DTypeLike, …] | None

class jax.lax.FftType(value)[source]#

描述要执行的 FFT 操作的类型。

FFT = 0#

正向复数到复数 FFT。

IFFT = 1#

逆向复数到复数 FFT。

IRFFT = 3#

逆向实数到复数 FFT。

RFFT = 2#

正向实数到复数 FFT。

class jax.lax.GatherDimensionNumbers(offset_dims, collapsed_slice_dims, start_index_map, operand_batching_dims=(), start_indices_batching_dims=())[source]#

描述 XLA 的 Gather 运算符 的维度编号参数。有关维度编号含义的更多详细信息，请参阅 XLA 文档。

参数:

  • offset_dims (tuple[int, ...]) – gather 输出中偏移到从 operand 切片的数组中的维度集合。 必须是一个升序排列的整数元组，每个整数代表输出的维度编号。

  • collapsed_slice_dims (tuple[int, ...]) – operand 中 i 维度的集合，这些维度的 slice_sizes[i] == 1，并且在 gather 的输出中不应具有相应的维度。 必须是一个升序排列的整数元组。

  • start_index_map (tuple[int, ...]) – 对于 start_indices 中的每个维度，给出 operand 中要切片的相应维度。 必须是一个整数元组，大小等于 start_indices.shape[-1]。

  • operand_batching_dims (tuple[int, ...]) – operand 中的批处理维度 i 的集合，这些维度的 slice_sizes[i] == 1，并且应该在 start_indices (在 start_indices_batching_dims 中的相同索引处) 和 gather 的输出中都具有相应的维度。 必须是一个升序排列的整数元组。

  • start_indices_batching_dims (tuple[int, ...]) – start_indices 中的批处理维度 i 的集合，这些维度应该在 operand (在 operand_batching_dims 中的相同索引处) 和 gather 的输出中都具有相应的维度。 必须是一个整数元组（顺序根据与 operand_batching_dims 的对应关系固定）。

与 XLA 的 GatherDimensionNumbers 结构不同，index_vector_dim 是隐式的；始终存在索引向量维度，并且它必须始终是最后一个维度。 要收集标量索引，请添加大小为 1 的尾部维度。

class jax.lax.GatherScatterMode(value)[source]#

描述如何在 gather 或 scatter 中处理越界索引。

可能的值为

CLIP

索引将被钳制到最近的范围内值，即，使得要 gather 的整个窗口都在范围内。

FILL_OR_DROP

如果 gather 的窗口的任何部分超出范围，则返回的整个窗口（即使是那些原本在范围内的元素）都将填充一个常量。 如果 scatter 的窗口的任何部分超出范围，则整个窗口将被丢弃。

PROMISE_IN_BOUNDS

用户承诺索引在范围内。 将不会执行额外的检查。 实际上，对于当前的 XLA 实现，这意味着越界 gather 将被钳制，但越界 scatter 将被丢弃。 如果索引超出范围，则梯度将不正确。

class jax.lax.Precision(value)[source]#

用于 lax 矩阵乘法相关函数的精度枚举。

JAX 函数的设备相关的 precision 参数通常控制加速器后端（即 TPU 和 GPU）上数组计算的速度和精度之间的权衡。 对 CPU 后端没有影响。 这仅对 float32 计算有效，并且不影响输入/输出数据类型。 成员包括

DEFAULT

最快模式，但精度最低。 在 TPU 上：以 bfloat16 执行 float32 计算。 在 GPU 上：如果可用（例如在 A100 和 H100 GPU 上），则使用 tensorfloat32，否则使用标准 float32（例如在 V100 GPU 上）。 别名： 'default', 'fastest'。

HIGH

较慢但更精确。 在 TPU 上：以 3 个 bfloat16 过程执行 float32 计算。 在 GPU 上：在可用时使用 tensorfloat32，否则使用 float32。 别名： 'high'。

HIGHEST

最慢但最精确。 在 TPU 上：以 6 个 bfloat16 过程执行 float32 计算。 别名： 'highest'。 在 GPU 上：使用 float32。

jax.lax.PrecisionLike#

别名： None | str | Precision | tuple[str, str] | tuple[Precision, Precision] | DotAlgorithm | DotAlgorithmPreset

class jax.lax.RandomAlgorithm(value)[source]#

描述用于 rng_bit_generator 的 PRNG 算法。

RNG_DEFAULT = 0#

平台的默认算法。

RNG_THREE_FRY = 1#

Threefry-2x32 PRNG 算法。

RNG_PHILOX = 2#

Philox-4x32 PRNG 算法。

class jax.lax.RoundingMethod(value)[source]#

jax.lax.round() 中用于处理中间值（例如，0.5）的舍入策略。

AWAY_FROM_ZERO = 0#

将中间值四舍五入到远离零的方向（例如，0.5 -> 1，-0.5 -> -1）。

TO_NEAREST_EVEN = 1#

将中间值四舍五入到最接近的偶数整数。 这也称为“银行家舍入法”（例如，0.5 -> 0，1.5 -> 2）。

class jax.lax.ScatterDimensionNumbers(update_window_dims, inserted_window_dims, scatter_dims_to_operand_dims, operand_batching_dims=(), scatter_indices_batching_dims=())[source]#

描述 XLA 的 Scatter 运算符 的维度编号参数。 有关维度编号含义的更多详细信息，请参阅 XLA 文档。

参数:

  • update_window_dims (Sequence[int]) – updates 中作为窗口维度的维度集合。 必须是一个升序排列的整数元组，每个整数代表一个维度编号。

  • inserted_window_dims (Sequence[int]) – 必须插入到 updates 形状中的大小为 1 的窗口维度集合。必须是整数元组，并按升序排列，每个整数代表输出的维度编号。在 gather 的情况下，这些是 collapsed_slice_dims 的镜像。

  • scatter_dims_to_operand_dims (Sequence[int]) – 对于 scatter_indices 中的每个维度，给出 operand 中对应的维度。必须是整数序列，其大小等于 scatter_indices.shape[-1]。

  • operand_batching_dims (Sequence[int]) – operand 中批处理维度 i 的集合，这些维度应该在 scatter_indices (在 scatter_indices_batching_dims 中的相同索引处) 和 updates 中都有对应的维度。必须是整数元组，并按升序排列。在 gather 的情况下，这些是 operand_batching_dims 的镜像。

  • scatter_indices_batching_dims (Sequence[int]) – scatter_indices 中批处理维度 i 的集合，这些维度应该在 operand (在 operand_batching_dims 中的相同索引处) 和 gather 的输出中都有对应的维度。必须是整数元组 (顺序根据与 input_batching_dims 的对应关系固定)。在 gather 的情况下，这些是 start_indices_batching_dims 的镜像。

与 XLA 的 ScatterDimensionNumbers 结构不同，index_vector_dim 是隐式的；始终存在索引向量维度，并且它必须始终是最后一个维度。要分散标量索引，请添加大小为 1 的尾部维度。