KerasHub:预训练模型 / API 文档 / 模型架构 / Gemma / GemmaBackbone 模型

GemmaBackbone 模型

[源代码]

GemmaBackbone

keras_hub.models.GemmaBackbone(
    vocabulary_size,
    num_layers,
    num_query_heads,
    num_key_value_heads,
    hidden_dim,
    intermediate_dim,
    head_dim,
    query_head_dim_normalize=True,
    use_post_ffw_norm=False,
    use_post_attention_norm=False,
    attention_logit_soft_cap=None,
    final_logit_soft_cap=None,
    use_sliding_window_attention=False,
    sliding_window_size=4096,
    layer_norm_epsilon=1e-06,
    dropout=0,
    dtype=None,
    **kwargs
)

带有超参数的 Gemma 核心网络。

此骨干网络实现了 Gemma 模型的基础 Transformer 网络。它包括嵌入查找和 Transformer 层。此骨干网络将为每个词元输出最终的隐藏状态,而不是词汇空间上的生成式预测。有关用于文本生成的更高级别对象,请参阅 keras_hub.models.GemmaCausalLM

默认构造函数提供一个完全可定制、随机初始化的 Gemma 模型,可以具有任意数量的层、头和嵌入维度。要加载预设的架构和权重,请使用 from_preset 构造函数。

参数

  • vocabulary_size:整数。词元词汇表的大小。
  • num_layers:整数。Transformer 层的数量。
  • num_query_heads:整数。注意力层中查询投影的头数。
  • num_key_value_heads:整数。注意力层中键和值投影的头数。
  • hidden_dim:整数。每个 Transformer 层末尾的 Transformer 隐藏状态的大小。
  • intermediate_dim:整数。每个 Transformer 的双层前馈网络中第一个 Dense 层的输出维度。
  • head_dim:整数。每个注意力头的大小。
  • layer_norm_epsilon:浮点数。用于 Transformer 模型中每个层归一化的 epsilon 值。
  • dropout:浮点数。Transformer 编码器的 dropout 概率。
  • query_head_dim_normalize:布尔值。如果为 True,则在注意力操作之前使用 head_dim 对查询进行归一化。如果为 False,则使用 hidden_dim / num_query_heads 对查询进行归一化。默认为 True。
  • use_post_ffw_norm:布尔值。是否在前馈块之后进行归一化。默认为 False。
  • use_post_attention_norm:布尔值。是否在注意力块之后进行归一化。默认为 False。
  • attention_logit_soft_cap:None 或整数。注意力 logit 的软上限。默认为 None。
  • final_logit_soft_cap:None 或整数。最终 logit 的软上限。默认为 None。use_sliding_window_attention 布尔值。是否使用滑动局部窗口注意力。默认为 False。
  • sliding_window_size:整数。滑动局部窗口的大小。默认为 4096。
  • dtype:字符串或 keras.mixed_precision.DTypePolicy。用于模型计算和权重的 dtype。请注意,无论 dtype 如何,某些计算(例如 softmax 和层归一化)将始终以 float32 精度完成。

示例

input_data = {
    "token_ids": np.ones(shape=(1, 12), dtype="int32"),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0]]),
}

# Pretrained Gemma decoder.
model = keras_hub.models.GemmaBackbone.from_preset("gemma_2b_en")
model(input_data)

# Randomly initialized Gemma decoder with custom config.
model = keras_hub.models.GemmaBackbone(
    vocabulary_size=50257,
    num_layers=12,
    num_query_heads=12,
    num_key_value_heads=1,
    hidden_dim=768,
    intermediate_dim=3072,
    head_dim=64,
)
model(input_data)

[源代码]

from_preset 方法

GemmaBackbone.from_preset(preset, load_weights=True, **kwargs)

从模型预设实例化一个 keras_hub.models.Backbone

预设是一个包含配置、权重和其他文件资源的目录,用于保存和加载预训练模型。preset 可以作为以下之一传递:

  1. 一个内置的预设标识符,如 'bert_base_en'
  2. 一个 Kaggle Models 句柄,如 'kaggle://user/bert/keras/bert_base_en'
  3. 一个 Hugging Face 句柄,如 'hf://user/bert_base_en'
  4. 一个本地预设目录的路径,如 './bert_base_en'

此构造函数可以通过两种方式之一调用。可以从基类调用,如 keras_hub.models.Backbone.from_preset(),也可以从模型类调用,如 keras_hub.models.GemmaBackbone.from_preset()。如果从基类调用,返回对象的子类将从预设目录中的配置推断出来。

对于任何 Backbone 子类,您可以运行 cls.presets.keys() 来列出该类上所有可用的内置预设。

参数

  • preset:字符串。一个内置预设标识符、一个 Kaggle Models 句柄、一个 Hugging Face 句柄或一个本地目录的路径。
  • load_weights:布尔值。如果为 `True`,权重将被加载到模型架构中。如果为 `False`,权重将被随机初始化。

示例

# Load a Gemma backbone with pre-trained weights.
model = keras_hub.models.Backbone.from_preset(
    "gemma_2b_en",
)

# Load a Bert backbone with a pre-trained config and random weights.
model = keras_hub.models.Backbone.from_preset(
    "bert_base_en",
    load_weights=False,
)
预设 参数 描述
gemma_2b_en 25.1 亿 20 亿参数、18 层的 Gemma 基础模型。
gemma_instruct_2b_en 25.1 亿 20 亿参数、18 层的 Gemma 指令微调模型。
gemma_1.1_instruct_2b_en 25.1 亿 20 亿参数、18 层的 Gemma 指令微调模型。1.1 版本更新提高了模型质量。
code_gemma_1.1_2b_en 25.1 亿 20 亿参数、18 层的 CodeGemma 模型。此模型针对代码补全的“填充中间”(FIM) 任务进行了训练。1.1 版本更新提高了模型质量。
code_gemma_2b_en 25.1 亿 20 亿参数、18 层的 CodeGemma 模型。此模型针对代码补全的“填充中间”(FIM) 任务进行了训练。
gemma2_2b_en 26.1 亿 20 亿参数、26 层的 Gemma 基础模型。
gemma2_instruct_2b_en 26.1 亿 20 亿参数、26 层的 Gemma 指令微调模型。
shieldgemma_2b_en 26.1 亿 20 亿参数、26 层的 ShieldGemma 模型。
gemma_7b_en 85.4 亿 70 亿参数、28 层的 Gemma 基础模型。
gemma_instruct_7b_en 85.4 亿 70 亿参数、28 层的 Gemma 指令微调模型。
gemma_1.1_instruct_7b_en 85.4 亿 70 亿参数、28 层的 Gemma 指令微调模型。1.1 版本更新提高了模型质量。
code_gemma_7b_en 85.4 亿 70 亿参数、28 层的 CodeGemma 模型。此模型针对代码补全的“填充中间”(FIM) 任务进行了训练。
code_gemma_instruct_7b_en 85.4 亿 70 亿参数、28 层的 CodeGemma 指令微调模型。此模型针对与代码相关的聊天用例进行了训练。
code_gemma_1.1_instruct_7b_en 85.4 亿 70 亿参数、28 层的 CodeGemma 指令微调模型。此模型针对与代码相关的聊天用例进行了训练。1.1 版本更新提高了模型质量。
gemma2_9b_en 92.4 亿 90 亿参数、42 层的 Gemma 基础模型。
gemma2_instruct_9b_en 92.4 亿 90 亿参数、42 层的 Gemma 指令微调模型。
shieldgemma_9b_en 92.4 亿 90 亿参数、42 层的 ShieldGemma 模型。
gemma2_27b_en 272.3 亿 270 亿参数、42 层的 Gemma 基础模型。
gemma2_instruct_27b_en 272.3 亿 270 亿参数、42 层的 Gemma 指令微调模型。
shieldgemma_27b_en 272.3 亿 270 亿参数、42 层的 ShieldGemma 模型。

token_embedding 属性

keras_hub.models.GemmaBackbone.token_embedding

一个用于嵌入词元 ID 的 keras.layers.Embedding 实例。

该层将整数词元 ID 嵌入到模型的隐藏维度。


[源代码]

enable_lora 方法

GemmaBackbone.enable_lora(rank, target_names=None)

在骨干网络上启用 LoRA。

调用此方法将冻结骨干网络上的所有权重,同时在注意力层的查询和值 EinsumDense 层上启用 LoRA。


[源代码]

get_layout_map 方法

GemmaBackbone.get_layout_map(
    device_mesh, model_parallel_dim_name="model", data_parallel_dim_name="batch"
)

获取一个用于模型并行分布的 keras.distribution.LayoutMap

返回的 LayoutMap 包含 gemma 骨干网络权重的分片规范,以便您可以使用它在加速器之间分配权重。

示例

# Feel free to change the mesh shape to balance data and model
# parallelism
mesh = keras.distribution.DeviceMesh(
    shape=(1, 8), axis_names=('batch', 'model'),
    devices=keras.distribution.list_devices())
layout_map = GemmaBackbone.get_layout_map(
    mesh, model_parallel_dim_name="model")

distribution = keras.distribution.ModelParallel(
    layout_map=layout_map, batch_dim_name='batch')
with distribution.scope():
   gemma_model = keras_hub.models.GemmaCausalLM.from_preset()

要查看布局映射是如何应用的,请加载模型然后运行(对于一个解码器块):

embedding_layer = gemma_model.backbone.get_layer("token_embedding")
decoder_block_1 = gemma_model.backbone.get_layer('decoder_block_1')
for variable in embedding_layer.weights + decoder_block_1.weights:
    print(
        f'{variable.path:<58}  {str(variable.shape):<16} '
        f'{str(variable.value.sharding.spec)}'
    )

参数

  • device_mesh:用于分布的 keras.distribution.DeviceMesh 实例。
  • model_parallel_dim_name:设备网格的轴名称,权重应在此轴上进行分区。
  • data_parallel_dim_name:设备网格的轴名称,数据应在此轴上进行分区。

返回:一个 keras.distribution.LayoutMap,其中包含所有模型权重的分片规范。