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: int。令牌词汇表的大小。
  • num_layers: int。Transformer 层的数量。
  • num_query_heads: int。注意力层中查询投影的头数。
  • num_key_value_heads: int。注意力层中键和值投影的头数。
  • hidden_dim: int。每个 Transformer 层结束时 Transformer 隐藏状态的大小。
  • intermediate_dim: int。每个 Transformer 的两层前馈网络中第一个密集层的输出维度。
  • head_dim: int。每个注意力头的大小。
  • layer_norm_epsilon: float。Transformer 模型中每个层归一化使用的 epsilon 值。
  • dropout: float。Transformer 编码器的 dropout 概率。
  • query_head_dim_normalize: boolean。如果为 True,则在使用 head_dim 进行注意力计算之前对查询进行归一化。如果为 False,则使用 hidden_dim / num_query_heads 对查询进行归一化。默认为 True。
  • use_post_ffw_norm: boolean。是否在前馈块之后进行归一化。默认为 False。
  • use_post_attention_norm: boolean。是否在注意力块之后进行归一化。默认为 False。
  • attention_logit_soft_cap: None 或 int。注意力 logits 的软上限。默认为 None。
  • final_logit_soft_cap: None 或 int。最终 logits 的软上限。默认为 None。use_sliding_window_attention boolean。是否使用滑动局部窗口注意力。默认为 False。
  • sliding_window_size: int。滑动局部窗口的大小。默认为 4096。
  • dtype: string 或 keras.mixed_precision.DTypePolicy。用于模型计算和权重的 dtype。请注意,某些计算(例如 softmax 和层归一化)将始终以 float32 精度完成,而与 dtype 无关。

示例

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: string。内置预设标识符、Kaggle Models 句柄、Hugging Face 句柄或本地目录的路径。
  • load_weights: bool。如果为 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 2.51B 20 亿参数、18 层、基础 Gemma 模型。
gemma_instruct_2b_en 2.51B 20 亿参数、18 层、指令调优 Gemma 模型。
gemma_1.1_instruct_2b_en 2.51B 20 亿参数、18 层、指令调优 Gemma 模型。1.1 更新提高了模型质量。
code_gemma_1.1_2b_en 2.51B 20 亿参数、18 层、CodeGemma 模型。此模型已在代码完成的填空中间 (FIM) 任务上进行训练。1.1 更新提高了模型质量。
code_gemma_2b_en 2.51B 20 亿参数、18 层、CodeGemma 模型。此模型已在代码完成的填空中间 (FIM) 任务上进行训练。
gemma2_2b_en 2.61B 20 亿参数、26 层、基础 Gemma 模型。
gemma2_instruct_2b_en 2.61B 20 亿参数、26 层、指令调优 Gemma 模型。
shieldgemma_2b_en 2.61B 20 亿参数、26 层、ShieldGemma 模型。
gemma_7b_en 8.54B 70 亿参数、28 层、基础 Gemma 模型。
gemma_instruct_7b_en 8.54B 70 亿参数、28 层、指令调优 Gemma 模型。
gemma_1.1_instruct_7b_en 8.54B 70 亿参数、28 层、指令调优 Gemma 模型。1.1 更新提高了模型质量。
code_gemma_7b_en 8.54B 70 亿参数、28 层、CodeGemma 模型。此模型已在代码完成的填空中间 (FIM) 任务上进行训练。
code_gemma_instruct_7b_en 8.54B 70 亿参数、28 层、指令调优 CodeGemma 模型。此模型已针对与代码相关的聊天用例进行训练。
code_gemma_1.1_instruct_7b_en 8.54B 70 亿参数、28 层、指令调优 CodeGemma 模型。此模型已针对与代码相关的聊天用例进行训练。1.1 更新提高了模型质量。
gemma2_9b_en 9.24B 90 亿参数、42 层、基础 Gemma 模型。
gemma2_instruct_9b_en 9.24B 90 亿参数、42 层、指令调优 Gemma 模型。
shieldgemma_9b_en 9.24B 90 亿参数、42 层、ShieldGemma 模型。
gemma2_27b_en 27.23B 270 亿参数、42 层、基础 Gemma 模型。
gemma2_instruct_27b_en 27.23B 270 亿参数、42 层、指令调优 Gemma 模型。
shieldgemma_27b_en 27.23B 270 亿参数、42 层、ShieldGemma 模型。

token_embedding 属性

keras_hub.models.GemmaBackbone.token_embedding

用于嵌入令牌 ID 的 keras.layers.Embedding 实例。

此层将整数令牌 ID 嵌入到模型的隐藏维度中。


[来源]

enable_lora 方法

GemmaBackbone.enable_lora(rank)

在骨干网络上启用 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