Keras 3 API 文档 / KerasNLP / 预训练模型 / Gemma / GemmaCausalLMPreprocessor 层

GemmaCausalLMPreprocessor 层

[源代码]

GemmaCausalLMPreprocessor

keras_nlp.models.GemmaCausalLMPreprocessor(
    tokenizer, sequence_length=1024, add_start_token=True, add_end_token=True, **kwargs
)

Gemma 因果语言模型预处理器。

此预处理层旨在与 keras_nlp.models.GemmaCausalLM 一起使用。默认情况下,它将接收字符串批次,并以 (x, y, sample_weight) 格式返回输出,其中 y 标签是 x 序列中的下一个 token ID。

为了用于生成,该层还公开了两种方法 generate_preprocess()generate_postprocess()。当此预处理器附加到 keras_nlp.models.GemmaCausalLM 实例时,这些方法将在 generate() 中隐式调用。它们也可以单独调用(例如,在单独的进程中预计算生成预处理输入)。

参数

  • tokenizer:一个 keras_nlp.models.GemmaTokenizer 实例。
  • sequence_length:打包输入的长度。
  • add_start_token:如果为 True,则预处理器将在每个输入序列之前添加分词器起始 token。
  • add_end_token:如果为 True,则预处理器将在每个输入序列之后添加分词器结束 token。

调用参数

  • x:字符串、tf.Tensor 或 Python 字符串列表。
  • y:标签数据。应始终为 None,因为该层生成标签。
  • sample_weight:标签权重。应始终为 None,因为该层生成标签权重。
  • sequence_length:传递以覆盖层的配置 sequence_length

示例

# Load the preprocessor from a preset.
preprocessor = keras_nlp.models.GemmaCausalLMPreprocessor.from_preset(
    "gemma_2b_en"
)

# Tokenize and pack a single sentence.
preprocessor("The quick brown fox jumped.")

# Tokenize a batch of sentences.
preprocessor(["The quick brown fox jumped.", "Call me Ishmael."])

# Apply tokenization to a [`tf.data.Dataset`](https://tensorflowcn.cn/api_docs/python/tf/data/Dataset).
features = tf.constant(["The quick brown fox.", "Call me Ishmael."])
ds = tf.data.Dataset.from_tensor_slices(features)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Prepare tokens for generation (no end token).
preprocessor.generate_preprocess(["The quick brown fox jumped."])

# Map generation outputs back to strings.
preprocessor.generate_postprocess({
    'token_ids': np.array([[2, 714, 4320, 8426, 25341, 32292, 235265, 0]]),
    'padding_mask': np.array([[ 1,  1,  1,  1,  1,  1,  1, 0]]),
})

[源代码]

from_preset 方法

GemmaCausalLMPreprocessor.from_preset(preset, **kwargs)

从模型预设实例化 keras_nlp.models.Preprocessor

预设是用于保存和加载预训练模型的配置、权重和其他文件资产的目录。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'

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

由于给定模型通常有多个预处理类,因此此方法应在特定子类上调用,例如 keras_nlp.models.BertTextClassifierPreprocessor.from_preset()

参数

  • preset:字符串。内置预设标识符、Kaggle Models 句柄、Hugging Face 句柄或本地目录的路径。

示例

# Load a preprocessor for Gemma generation.
preprocessor = keras_nlp.models.GemmaCausalLMPreprocessor.from_preset(
    "gemma_2b_en",
)

# Load a preprocessor for Bert classification.
preprocessor = keras_nlp.models.BertTextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设名称 参数 描述
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 模型。

tokenizer 属性

keras_nlp.models.GemmaCausalLMPreprocessor.tokenizer

用于将字符串分词成 token 的分词器。