► Keras 3 API 文档 / KerasHub / 预训练模型 / Gemma / GemmaCausalLM 模型

GemmaCausalLM 模型

[来源]

GemmaCausalLM 类

keras_hub.models.GemmaCausalLM(backbone, preprocessor=None, **kwargs)

用于因果语言建模的端到端 Gemma 模型。

因果语言模型 (LM) 基于之前的标记预测下一个标记。这种任务设置可用于在纯文本输入上无监督地训练模型，或自动回归地生成与用于训练的数据类似的纯文本。此任务可用于预训练或微调 Gemma 模型，只需调用 fit() 即可。

此模型有一个 generate() 方法，该方法根据提示生成文本。使用的生成策略由 compile() 上的附加 sampler 参数控制。您可以使用不同的 keras_hub.samplers 对象重新编译模型以控制生成。默认情况下，将使用 "greedy" 采样。

此模型可以选择配置一个 preprocessor 层，在这种情况下，它将在 fit()、predict()、evaluate() 和 generate() 期间自动对字符串输入应用预处理。在使用 from_preset() 创建模型时，默认情况下会执行此操作。

参数

示例

使用 generate() 进行文本生成。

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.generate("I want to say", max_length=30)

# Generate with batched prompts.
gemma_lm.generate(["This is a", "Where are you"], max_length=30)

使用自定义采样器编译 generate() 函数。

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.compile(sampler="top_k")
gemma_lm.generate("I want to say", max_length=30)

gemma_lm.compile(sampler=keras_hub.samplers.BeamSampler(num_beams=2))
gemma_lm.generate("I want to say", max_length=30)

在没有预处理的情况下使用 generate()。

prompt = {
    # Token ids for "<bos> Keras is".
    "token_ids": np.array([[2, 214064, 603, 0, 0, 0, 0]] * 2),
    # Use `"padding_mask"` to indicate values that should not be overridden.
    "padding_mask": np.array([[1, 1, 1, 0, 0, 0, 0]] * 2),
}

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en",
    preprocessor=None,
)
gemma_lm.generate(prompt)

对单个批次调用 fit()。

features = ["The quick brown fox jumped.", "I forgot my homework."]
gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.fit(x=features, batch_size=2)

启用 LoRA 微调调用 fit()。

features = ["The quick brown fox jumped.", "I forgot my homework."]
gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma.backbone.enable_lora(rank=4)
gemma_lm.fit(x=features, batch_size=2)

在没有预处理的情况下调用 fit()。

x = {
    # Token ids for "<bos> Keras is deep learning library<eos>"
    "token_ids": np.array([[2, 214064, 603, 5271, 6044, 9581, 1, 0]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 0]] * 2),
}
y = np.array([[214064, 603, 5271, 6044, 9581, 3, 0, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1, 1, 0, 0]] * 2)

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en",
    preprocessor=None,
)
gemma_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自定义骨干和词汇表。

tokenizer = keras_hub.models.GemmaTokenizer(
    proto="proto.spm",
)
preprocessor = keras_hub.models.GemmaCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_hub.models.GemmaBackbone(
    vocabulary_size=30552,
    num_layers=4,
    num_heads=4,
    hidden_dim=256,
    intermediate_dim=512,
    max_sequence_length=128,
)
gemma_lm = keras_hub.models.GemmaCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
gemma_lm.fit(x=features, batch_size=2)

[来源]

from_preset 方法

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

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

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

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

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

此构造函数可以通过两种方式调用之一进行调用。从特定任务的基类（如 keras_hub.models.CausalLM.from_preset()）或从模型类（如 keras_hub.models.BertTextClassifier.from_preset()）调用。如果从基类调用，则返回对象的子类将从预设目录中的配置推断出来。

参数

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

示例

# Load a Gemma generative task.
causal_lm = keras_hub.models.CausalLM.from_preset(
    "gemma_2b_en",
)

# Load a Bert classification task.
model = keras_hub.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)
预设名称 参数 描述
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) 任务上进行了训练。
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_2b_en 2.61B 20 亿参数、26 层、基础 Gemma 模型。
gemma2_instruct_2b_en 2.61B 20 亿参数、26 层、指令调整的 Gemma 模型。
gemma2_9b_en 9.24B 90 亿参数、42 层、基础 Gemma 模型。
gemma2_instruct_9b_en 9.24B 90 亿参数、42 层、指令调整的 Gemma 模型。
gemma2_27b_en 27.23B 270 亿参数、42 层、基础 Gemma 模型。
gemma2_instruct_27b_en 27.23B 270 亿参数、42 层、指令调整的 Gemma 模型。
shieldgemma_2b_en 2.61B 20 亿参数、26 层、ShieldGemma 模型。
shieldgemma_9b_en 9.24B 90 亿参数、42 层、ShieldGemma 模型。
shieldgemma_27b_en 27.23B 270 亿参数、42 层、ShieldGemma 模型。

[来源]

generate 方法

GemmaCausalLM.generate(inputs, max_length=None, stop_token_ids="auto")

根据提示 inputs 生成文本。

此方法根据给定的 inputs 生成文本。用于生成的采样方法可以通过 compile() 方法设置。

如果 inputs 是一个 tf.data.Dataset，则输出将“逐批”生成并连接起来。否则，所有输入将被处理为单个批次。

如果将 preprocessor 附加到模型，则 inputs 将在 generate() 函数内部进行预处理，并且应该与 preprocessor 层期望的结构匹配（通常是原始字符串）。如果没有附加 preprocessor，则输入应该与 backbone 期望的结构匹配。有关每种方法的演示，请参阅上面的示例用法。

参数

  • inputs: python 数据、张量数据或 tf.data.Dataset。如果将 preprocessor 附加到模型，则 inputs 应该与 preprocessor 层期望的结构匹配。如果没有附加 preprocessor，则 inputs 应该与 backbone 模型期望的结构匹配。
  • max_length: 可选。整数。生成序列的最大长度。将默认为 preprocessor 的最大配置 sequence_length。如果 preprocessor 为 None，则 inputs 应该填充到所需的最大长度，并且此参数将被忽略。
  • stop_token_ids: 可选。None、"auto" 或标记 ID 元组。默认为 "auto"，它使用 preprocessor.tokenizer.end_token_id。未指定处理器将产生错误。None 在生成 max_length 个标记后停止生成。您也可以指定模型应停止的标记 ID 列表。请注意，标记序列将被解释为停止标记，不支持多标记停止序列。

backbone 属性

keras_hub.models.GemmaCausalLM.backbone

具有核心架构的 keras_hub.models.Backbone 模型。

preprocessor 属性

keras_hub.models.GemmaCausalLM.preprocessor

用于预处理输入的 keras_hub.models.Preprocessor 层。

[来源]

score 方法

GemmaCausalLM.score(
    token_ids,
    padding_mask=None,
    scoring_mode="logits",
    layer_intercept_fn=None,
    target_ids=None,
)

对由提供的标记 ID 表示的生成进行评分。

参数

  • token_ids: 一个[batch_size, num_tokens] 张量，包含要评分的标记。通常，此张量捕获对 GemmaCausalLM.generate() 的调用的输出，即，输入文本和模型生成的文本的标记。
  • padding_mask: 一个[batch_size, num_tokens] 张量，指示在生成过程中应保留的标记。这是 GemmaBackbone 所需的工件，对该函数的计算没有影响。如果省略，此函数将使用 keras.ops.ones() 创建一个适当形状的张量。
  • scoring_mode: 要返回的评分类型，"logits" 或 "loss"，两者都将是每个输入标记的评分。
  • layer_intercept_fn: 一个可选函数，用于使用额外计算来增强激活，例如，作为可解释性研究的一部分。此函数将被传递激活作为其第一个参数，以及与该骨干层关联的数字索引。此索引_不是_self.backbone.layers_ 中的索引。索引 -1 伴随通过在正向方向上对 token_ids 调用 self.backbone.token_embedding() 而返回的嵌入。所有后续索引将是骨干中每个 Transformers 层返回的激活的 0 索引。此函数必须返回一个[batch_size, num_tokens, hidden_dims] 张量，该张量可以作为模型中下一层的输入传递。
  • target_ids: 一个[batch_size, num_tokens] 张量，包含应根据其计算损失的预测标记。如果提供了标记跨度（张量中沿 axis=1 的连续真值），则损失将被计算为这些标记的聚合。

引发

  • ValueError: 如果提供了不受支持的 scoring_mode，或者在使用 ScoringMode.LOSS 时未提供 target_ids。

返回值

每个标记的评分，作为一个大小为[batch_size, num_tokens, vocab_size] 的张量，在 "logits" 模式下，或[batch_size, num_tokens]，在 "loss" 模式下。

示例

使用 TensorFlow 计算嵌入和损失评分之间的梯度

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en"
)
generations = gemma_lm.generate(
    ["This is a", "Where are you"],
    max_length=30
)
preprocessed = gemma_lm.preprocessor.generate_preprocess(generations)
generation_ids = preprocessed["token_ids"]
padding_mask = preprocessed["padding_mask"]
target_ids = keras.ops.roll(generation_ids, shift=-1, axis=1)

embeddings = None
with tf.GradientTape(watch_accessed_variables=True) as tape:
    def layer_intercept_fn(x, i):
        if i == -1:
            nonlocal embeddings, tape
            embeddings = x
            tape.watch(embeddings)
        return x

    losses = gemma_lm.score(
        token_ids=generation_ids,
        padding_mask=padding_mask,
        scoring_mode="loss",
        layer_intercept_fn=layer_intercept_fn,
        target_ids=target_ids,
    )

grads = tape.gradient(losses, embeddings)
GemmaCausalLM 模型
GemmaCausalLM 类
from_preset 方法
generate 方法
backbone 属性
preprocessor 属性
score 方法