jax.random 模块#

用于伪随机数生成的实用程序。

jax.random 包提供了一些用于确定性生成伪随机数序列的例程。

基本用法#

>>> seed = 1701
>>> num_steps = 100
>>> key = jax.random.key(seed)
>>> for i in range(num_steps):
...   key, subkey = jax.random.split(key)
...   params = compiled_update(subkey, params, next(batches))

PRNG 键#

与 NumPy 和 SciPy 用户可能习惯的有状态伪随机数生成器 (PRNG) 不同，JAX 的所有随机函数都需要将显式的 PRNG 状态作为第一个参数传递。随机状态由一种特殊的数组元素类型描述，我们称之为密钥 (key)，通常由 jax.random.key() 函数生成。

>>> from jax import random
>>> key = random.key(0)
>>> key
Array((), dtype=key<fry>) overlaying:
[0 0]

然后，此密钥可以在 JAX 的任何随机数生成例程中使用。

>>> random.uniform(key)
Array(0.947667, dtype=float32)

请注意，使用密钥不会修改它，因此重用同一个密钥将导致相同的结果。

>>> random.uniform(key)
Array(0.947667, dtype=float32)

如果您需要新的随机数，可以使用 jax.random.split() 生成新的子密钥。

>>> key, subkey = random.split(key)
>>> random.uniform(subkey)
Array(0.00729382, dtype=float32)

注意

在 JAX v0.4.16 中引入了具有诸如上面的 key<fry> 等元素类型的类型化密钥数组。在此之前，密钥通常用 uint32 数组表示，其最后一个维度表示密钥的位级表示。

这两种形式的密钥数组仍然可以使用 jax.random 模块创建和使用。新的类型化密钥数组使用 jax.random.key() 创建。旧版的 uint32 密钥数组使用 jax.random.PRNGKey() 创建。

要在两者之间进行转换，请使用 jax.random.key_data() 和 jax.random.wrap_key_data()。当与 JAX 外部的系统（例如，将数组导出为可序列化格式）或将密钥传递给假设旧版格式的基于 JAX 的库时，可能需要旧版密钥格式。

否则，建议使用类型化密钥。相对于类型化密钥，旧版密钥的注意事项包括：

  • 它们有一个额外的尾随维度。

  • 它们具有数字 dtype (uint32)，允许执行通常不应在密钥上执行的操作，例如整数算术。

  • 它们不携带有关 RNG 实现的信息。当旧版密钥传递给 jax.random 函数时，全局配置设置将确定 RNG 实现（请参阅下面的“高级 RNG 配置”）。

要了解有关此升级和密钥类型设计的更多信息，请参阅 JEP 9263。

高级#

设计和背景#

TLDR：JAX PRNG = Threefry 计数器 PRNG + 面向数组的功能性 分割模型

有关更多详细信息，请参阅 docs/jep/263-prng.md。

总而言之，除其他要求外，JAX PRNG 的目标是：

  1. 确保可重复性，

  2. 在向量化（生成数组值）和多副本、多核计算方面实现良好的并行化。特别是，它不应在随机函数调用之间使用排序约束。

高级 RNG 配置#

JAX 提供了多种 PRNG 实现。可以使用 jax.random.key 的可选 impl 关键字参数选择特定的实现。如果未将 impl 选项传递给 key 构造函数，则该实现由全局 jax_default_prng_impl 配置标志确定。可用实现的字符串名称为：

  • "threefry2x32"（默认）：基于 Threefry 哈希函数变体的基于计数器的 PRNG，如 Salmon 等人 2011 年的这篇论文中所述。

  • "rbg" 和 "unsafe_rbg" (实验性)：构建在 XLA 的随机位生成器 (RBG) 算法之上的 PRNG。

    • "rbg" 使用 XLA RBG 生成随机数，而对于密钥派生（如 jax.random.split 和 jax.random.fold_in 中），它使用与 "threefry2x32" 相同的方法。

    • "unsafe_rbg" 将 XLA RBG 用于生成和密钥派生。

    这些实验性方案生成的随机数尚未经过经验随机性测试（例如 BigCrush）。

    "unsafe_rbg" 中的密钥派生也尚未经过经验测试。该名称强调“不安全”，因为密钥派生质量和生成质量尚未得到很好的理解。

    此外，"rbg" 和 "unsafe_rbg" 在 jax.vmap 下的行为异常。当在批量密钥上 vmapping 随机函数时，其输出值可能与其在相同密钥上的真实映射不同。相反，在 vmap 下，整个批量输出随机数仅从输入密钥批次的第一个密钥生成。例如，如果 keys 是 8 个密钥的向量，则 jax.vmap(jax.random.normal)(keys) 等于 jax.random.normal(keys[0], shape=(8,))。这种特殊性反映了针对 XLA RBG 有限的批处理支持的一种解决方法。

使用默认 RNG 的替代方案的原因包括：

  1. 对于 TPU，编译可能很慢。

  2. 在 TPU 上执行速度相对较慢。

自动分区

为了使 jax.jit 能够有效地自动分区生成分片随机数数组（或密钥数组）的函数，所有 PRNG 实现都需要额外的标志。

  • 对于 "threefry2x32" 和 "rbg" 密钥派生，请设置 jax_threefry_partitionable=True。

  • 对于 "unsafe_rbg" 和 "rbg" 随机生成，请设置 XLA 标志 --xla_tpu_spmd_rng_bit_generator_unsafe=1。

可以使用 XLA_FLAGS 环境变量设置 XLA 标志，例如 XLA_FLAGS=--xla_tpu_spmd_rng_bit_generator_unsafe=1。

有关 jax_threefry_partitionable 的更多信息，请参阅 https://jax.ac.cn/en/latest/notebooks/Distributed_arrays_and_automatic_parallelization.html#generating-random-numbers

总结

属性

Threefry

Threefry*

rbg

unsafe_rbg

rbg**

unsafe_rbg**

在 TPU 上最快

✅

✅

✅

✅

可高效分片（使用 pjit）

✅

✅

✅

在分片之间相同

✅

✅

✅

✅

在 CPU/GPU/TPU 之间相同

✅

✅

密钥上精确的 jax.vmap

✅

✅

(*)：设置 jax_threefry_partitionable=1

(**)：设置 XLA_FLAGS=--xla_tpu_spmd_rng_bit_generator_unsafe=1

API 参考#

密钥创建和操作#

key(seed, *[, impl])

使用整数种子创建伪随机数生成器 (PRNG) 密钥。

key_data(keys)

恢复 PRNG 密钥数组的底层密钥数据的位。

wrap_key_data(key_bits_array, *[, impl])

将密钥数据位的数组包装到 PRNG 密钥数组中。

fold_in(key, data)

将数据折叠到 PRNG 密钥中以形成新的 PRNG 密钥。

split(key[, num])

通过添加前导轴将 PRNG 密钥拆分为 num 个新密钥。

clone(key)

克隆密钥以供重用

PRNGKey(seed, *[, impl])

使用整数种子创建旧版 PRNG 密钥。

随机采样器#

ball(key, d[, p, shape, dtype])

从单位 Lp 球中均匀采样。

bernoulli(key[, p, shape])

使用给定形状和均值采样 Bernoulli 随机值。

beta(key, a, b[, shape, dtype])

使用给定形状和浮点 dtype 采样 Beta 随机值。

binomial(key, n, p[, shape, dtype])

使用给定形状和浮点 dtype 采样二项式随机值。

bits(key[, shape, dtype])

以无符号整数的形式采样均匀分布的比特。

categorical(key, logits[, axis, shape])

从分类分布中采样随机值。

cauchy(key[, shape, dtype])

采样具有给定形状和浮点数据类型的柯西随机值。

chisquare(key, df[, shape, dtype])

采样具有给定形状和浮点数据类型的卡方随机值。

choice(key, a[, shape, replace, p, axis])

从给定数组生成随机样本。

dirichlet(key, alpha[, shape, dtype])

采样具有给定形状和浮点数据类型的狄利克雷随机值。

double_sided_maxwell(key, loc, scale[, ...])

从双边麦克斯韦分布中采样。

exponential(key[, shape, dtype])

采样具有给定形状和浮点数据类型的指数随机值。

f(key, dfnum, dfden[, shape, dtype])

采样具有给定形状和浮点数据类型的F分布随机值。

gamma(key, a[, shape, dtype])

采样具有给定形状和浮点数据类型的伽马随机值。

generalized_normal(key, p[, shape, dtype])

从广义正态分布中采样。

geometric(key, p[, shape, dtype])

采样具有给定形状和浮点数据类型的几何随机值。

gumbel(key[, shape, dtype])

采样具有给定形状和浮点数据类型的耿贝尔随机值。

laplace(key[, shape, dtype])

采样具有给定形状和浮点数据类型的拉普拉斯随机值。

loggamma(key, a[, shape, dtype])

采样具有给定形状和浮点数据类型的对数伽马随机值。

logistic(key[, shape, dtype])

采样具有给定形状和浮点数据类型的逻辑随机值。

lognormal(key[, sigma, shape, dtype])

采样具有给定形状和浮点数据类型的对数正态随机值。

maxwell(key[, shape, dtype])

从单边麦克斯韦分布中采样。

multivariate_normal(key, mean, cov[, shape, ...])

采样具有给定均值和协方差的多元正态随机值。

normal(key[, shape, dtype])

采样具有给定形状和浮点数据类型的标准正态随机值。

orthogonal(key, n[, shape, dtype])

从正交群 O(n) 中均匀采样。

pareto(key, b[, shape, dtype])

采样具有给定形状和浮点数据类型的帕累托随机值。

permutation(key, x[, axis, independent])

返回一个随机置换的数组或范围。

poisson(key, lam[, shape, dtype])

采样具有给定形状和整数数据类型的泊松随机值。

rademacher(key[, shape, dtype])

从拉德马赫分布中采样。

randint(key, shape, minval, maxval[, dtype])

采样给定形状/数据类型，范围在[minval, maxval)内的均匀随机值。

rayleigh(key, scale[, shape, dtype])

采样具有给定形状和浮点数据类型的瑞利随机值。

t(key, df[, shape, dtype])

采样具有给定形状和浮点数据类型的学生t随机值。

triangular(key, left, mode, right[, shape, ...])

采样具有给定形状和浮点数据类型的三角随机值。

truncated_normal(key, lower, upper[, shape, ...])

采样具有给定形状和数据类型的截断标准正态随机值。

uniform(key[, shape, dtype, minval, maxval])

采样给定形状/数据类型，范围在[minval, maxval)内的均匀随机值。

wald(key, mean[, shape, dtype])

采样具有给定形状和浮点数据类型的沃尔德随机值。

weibull_min(key, scale, concentration[, ...])

从韦布尔分布中采样。