JaxLayer

[源代码]

JaxLayer 类

keras.layers.JaxLayer(
    call_fn, init_fn=None, params=None, state=None, seed=None, **kwargs
)

包装 JAX 模型的 Keras 层。

当使用 JAX 作为 Keras 的后端时，此层可以在 Keras 中使用 JAX 组件。

模型函数

此层接受 JAX 模型，模型以函数 call_fn 的形式提供，该函数必须接受以下参数，且参数名称必须完全一致：

• params：模型的可训练参数。
• state（可选）：模型的不可训练状态。如果模型没有不可训练状态，则可以省略。
• rng（可选）：一个 jax.random.PRNGKey 实例。如果模型在训练或推理期间都不需要 RNG，则可以省略。
• inputs：模型的输入，一个 JAX 数组或数组的 PyTree。
• training（可选）：一个参数，指定我们是在训练模式还是推理模式下，在训练模式下传递 True。如果模型在训练模式和推理模式下的行为相同，则可以省略。

inputs 参数是必需的。必须通过单个参数提供模型的输入。如果 JAX 模型将多个输入作为单独的参数，则必须将其组合到单个结构中，例如在 tuple 或 dict 中。

模型权重初始化

此层可以处理模型 params 和 state 的初始化，在这种情况下，必须提供 init_fn 参数。这允许模型使用正确的形状进行动态初始化。或者，如果已知形状，则可以使用 params 参数和可选的 state 参数来创建已初始化的模型。

如果提供，则 init_fn 函数必须接受以下参数，且参数名称必须完全一致：

• rng：一个 jax.random.PRNGKey 实例。
• inputs：一个 JAX 数组或数组的 PyTree，其中包含占位符值以提供输入的形状。
• training（可选）：一个参数，指定我们是在训练模式还是推理模式下。始终将 True 传递给 init_fn。无论 call_fn 是否具有 training 参数，都可以省略。

具有不可训练状态的模型

对于具有不可训练状态的 JAX 模型：

• call_fn 必须具有 state 参数
• call_fn 必须返回一个 tuple，其中包含模型的输出和模型新的不可训练状态
• init_fn 必须返回一个 tuple，其中包含模型的初始可训练参数和模型的初始不可训练状态。

此代码显示了具有不可训练状态的模型的 call_fn 和 init_fn 签名可能的组合。在此示例中，模型在 call_fn 中具有 training 参数和 rng 参数。

def stateful_call(params, state, rng, inputs, training):
    outputs = ...
    new_state = ...
    return outputs, new_state

def stateful_init(rng, inputs):
    initial_params = ...
    initial_state = ...
    return initial_params, initial_state

没有不可训练状态的模型

对于没有不可训练状态的 JAX 模型：

• call_fn 不得具有 state 参数
• call_fn 只能返回模型的输出
• init_fn 只能返回模型的初始可训练参数。

此代码显示了没有不可训练状态的模型的 call_fn 和 init_fn 签名可能的组合。在此示例中，模型在 call_fn 中没有 training 参数，也没有 rng 参数。

def stateless_call(params, inputs):
    outputs = ...
    return outputs

def stateless_init(rng, inputs):
    initial_params = ...
    return initial_params

符合所需签名

如果模型的签名与 JaxLayer 所需的签名不同，则可以轻松编写包装方法来调整参数。此示例显示了一个模型，该模型将多个输入作为单独的参数，在 dict 中期望多个 RNG，并且具有与 training 含义相反的 deterministic 参数。为了符合要求，输入使用 tuple 组合到一个结构中，RNG 被拆分并用于填充预期的 dict，并且布尔标志被取反。

def my_model_fn(params, rngs, input1, input2, deterministic):
    ...
    if not deterministic:
        dropout_rng = rngs["dropout"]
        keep = jax.random.bernoulli(dropout_rng, dropout_rate, x.shape)
        x = jax.numpy.where(keep, x / dropout_rate, 0)
        ...
    ...
    return outputs

def my_model_wrapper_fn(params, rng, inputs, training):
    input1, input2 = inputs
    rng1, rng2 = jax.random.split(rng)
    rngs = {"dropout": rng1, "preprocessing": rng2}
    deterministic = not training
    return my_model_fn(params, rngs, input1, input2, deterministic)

keras_layer = JaxLayer(my_model_wrapper_fn, params=initial_params)

与 Haiku 模块一起使用

JaxLayer 允许以 Haiku 组件的形式使用 haiku.Module。这是通过根据 Haiku 模式转换模块，然后在 call_fn 参数中传递 module.apply，并在需要时在 init_fn 参数中传递 module.init 来实现的。

如果模型具有不可训练状态，则应使用 haiku.transform_with_state 进行转换。如果模型没有不可训练状态，则应使用 haiku.transform 进行转换。此外，并且可选地，如果模块在“apply”中不使用 RNG，则可以使用 haiku.without_apply_rng 进行转换。

以下示例显示了如何从一个 Haiku 模块创建 JaxLayer，该模块通过 hk.next_rng_key() 使用随机数生成器，并接受一个训练位置参数。

class MyHaikuModule(hk.Module):
    def __call__(self, x, training):
        x = hk.Conv2D(32, (3, 3))(x)
        x = jax.nn.relu(x)
        x = hk.AvgPool((1, 2, 2, 1), (1, 2, 2, 1), "VALID")(x)
        x = hk.Flatten()(x)
        x = hk.Linear(200)(x)
        if training:
            x = hk.dropout(rng=hk.next_rng_key(), rate=0.3, x=x)
        x = jax.nn.relu(x)
        x = hk.Linear(10)(x)
        x = jax.nn.softmax(x)
        return x

def my_haiku_module_fn(inputs, training):
    module = MyHaikuModule()
    return module(inputs, training)

transformed_module = hk.transform(my_haiku_module_fn)

keras_layer = JaxLayer(
    call_fn=transformed_module.apply,
    init_fn=transformed_module.init,
)

参数

• call_fn：调用模型的函数。请参阅上文关于其所接受的参数列表及其返回输出的说明。init_fn：调用以初始化模型的函数。请参阅上文关于其所接受的参数列表及其返回输出的说明。如果为 None，则必须提供 params 和/或 state。
• params：包含所有模型可训练参数的 PyTree。这允许传递训练参数或控制初始化。如果 params 和 state 都为 None，则在构建时调用 init_fn 以初始化模型的可训练参数。
• state：包含所有模型不可训练状态的 PyTree。这允许传递学习到的状态或控制初始化。如果 params 和 state 都为 None，并且 call_fn 接受 state 参数，则在构建时调用 init_fn 以初始化模型的不可训练状态。
• seed：随机数生成器的种子。可选。