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

GemmaCausalLM 模型

`GemmaCausalLM` 类

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

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

因果语言模型 (LM) 根据先前的 token 预测下一个 token。这种任务设置可用于在纯文本输入上无监督地训练模型，或自动回归地生成与训练数据相似的纯文本。通过简单地调用 fit()，此任务可用于预训练或微调 Gemma 模型。

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

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

参数

backbone: 一个 keras_hub.models.GemmaBackbone 实例。
preprocessor: 一个 keras_hub.models.GemmaCausalLMPreprocessor 或 None。如果为 None，此模型将不应用预处理，输入应在调用模型之前进行预处理。

示例

使用 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)

自定义 backbone 和词汇表。

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)

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

preset 是用于保存和加载预训练模型的配置、权重和其他文件资产的目录。preset 可以是以下之一：

内置 preset 标识符，例如 'bert_base_en'
Kaggle Models handle，例如 'kaggle://user/bert/keras/bert_base_en'
Hugging Face handle，例如 'hf://user/bert_base_en'
本地 preset 目录的路径，例如 './bert_base_en'

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

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

参数

preset: 字符串。一个内置 preset 标识符、Kaggle Models handle、Hugging Face handle 或本地目录的路径。
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,
)

Preset	参数	描述
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 模型。

[源代码]

`generate` 方法

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

根据提示 inputs 生成文本。

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

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

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

参数

inputs: python 数据、tensor 数据或 tf.data.Dataset。如果模型附加了 preprocessor，inputs 应匹配 preprocessor 层期望的结构。如果未附加 preprocessor，inputs 应匹配 backbone 模型期望的结构。
max_length: 可选。int。生成序列的最大长度。默认为 preprocessor 配置的最大 sequence_length。如果 preprocessor 为 None，inputs 应填充到所需的最大长度，并且此参数将被忽略。
stop_token_ids: 可选。None、“auto”或 token id 的元组。默认为“auto”，使用 preprocessor.tokenizer.end_token_id。未指定预处理器将产生错误。None 在生成 max_length 个 token 后停止生成。您也可以指定模型应停止的 token id 列表。请注意，每个 token 序列将被解释为一个停止 token，不支持多 token 停止序列。
strip_prompt: 可选。默认情况下，generate() 返回完整的提示以及模型生成的补全部分。如果此选项设置为 True，则仅返回新生成的文本。

`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,
)

对提供的 token id 表示的生成进行评分。

参数

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

抛出

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

每个 token 的分数，为一个大小为在“logits”模式下为 [batch_size, num_tokens, vocab_size]，或在“loss”模式下为 [batch_size, num_tokens]。

示例

使用 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)