► 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)

自定义骨干和词汇表。

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 可以作为以下之一传递：

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

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

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

参数

preset：字符串。一个内置预设标识符、一个 Kaggle Models 句柄、一个 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,
)

预设	参数	描述
vault_gemma_1b_en	1.04B	10 亿参数，26 层，VaultGemma 模型。
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 模型。
c2s_scale_gemma_2_2b_en	26.1 亿	一个 20 亿参数，基于 Gemma-2 架构构建的单细胞生物学感知模型。
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 模型。
c2s_scale_gemma_2_27b_en	272.3 亿	一个 270 亿参数，基于 Gemma-2 架构构建的单细胞生物学感知模型。

[源代码]

`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，则 inputs 应与 backbone 期望的结构匹配。请参阅上面的示例用法以了解每个的演示。

参数

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

引发

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

每个 token 的分数，在“logits”模式下为大小为[batch_size, num_tokens, vocab_size] 的张量，或[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)