► KerasHub：预训练模型 / API 文档 / 建模 API / CausalLMPreprocessor

CausalLMPreprocessor

[source]

CausalLMPreprocessor 类

keras_hub.models.CausalLMPreprocessor(
    tokenizer, sequence_length=1024, add_start_token=True, add_end_token=True, **kwargs
)

因果语言建模预处理层的基类。

CausalLMPreprocessor 任务包装一个 keras_hub.tokenizer.Tokenizer，为因果语言建模任务创建一个预处理层。它旨在与 keras.models.CausalLM 任务配对使用。

所有 CausalLMPreprocessor 都接受单个输入。这可以是单个字符串或一批字符串。请参见下面的示例。这些输入将被分词并填充/截断到固定序列长度。

此层将始终输出一个 (x, y, sample_weight) 元组，其中 x 是包含分词输入的字典，y 包含来自 x 的偏移 1 的 tokens，而 sample_weight 标记 y 包含填充值的位置。x 的确切内容将根据所使用的模型而有所不同。

CausalLMPreprocessor 包含两个额外的方法，generate_preprocess 和 generate_postprocess，用于生成。请参见下面的示例。

所有 CausalLMPreprocessor 任务都包含一个 from_preset() 构造函数，可用于加载预训练的配置和词汇表。您可以直接在此基类上调用 from_preset() 构造函数，在这种情况下，将自动实例化适合您模型的正确类。

示例。

preprocessor = keras_hub.models.CausalLMPreprocessor.from_preset(
    "bert_base_en_uncased",
    sequence_length=256, # Optional.
)

# Tokenize, mask and pack a single sentence.
x = "The quick brown fox jumped."
x, y, sample_weight = preprocessor(x)

# Tokenize and pad/truncate a batch of labeled sentences.
x = ["The quick brown fox jumped.", "Call me Ishmael."]
x, y, sample_weight = preprocessor(x)

# With a [`tf.data.Dataset`](https://tensorflowcn.cn/api_docs/python/tf/data/Dataset).
ds = tf.data.Dataset.from_tensor_slices(x)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Generate preprocess and postprocess.
x = preprocessor.generate_preprocess(x)  # Tokenized numeric inputs.
x = preprocessor.generate_postprocess(x)  # Detokenized string outputs.

[source]

from_preset 方法

CausalLMPreprocessor.from_preset(preset, config_file="preprocessor.json", **kwargs)

从模型预设实例化一个 keras_hub.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_hub.models.BertTextClassifierPreprocessor.from_preset()）上调用此方法。

参数

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

示例

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

# Load a preprocessor for Bert classification.
preprocessor = keras_hub.models.TextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设 参数 描述
bloom_560m_multi 559.21M 24 层 Bloom 模型，隐藏维度为 1024。在 45 种自然语言和 12 种编程语言上训练。
bloomz_560m_multi 559.21M 24 层 Bloom 模型，隐藏维度为 1024。在跨语言任务混合 (xP3) 数据集上微调。
bloom_1.1b_multi 1.07B 24 层 Bloom 模型，隐藏维度为 1536。在 45 种自然语言和 12 种编程语言上训练。
bloomz_1.1b_multi 1.07B 24 层 Bloom 模型，隐藏维度为 1536。在跨语言任务混合 (xP3) 数据集上微调。
bloom_1.7b_multi 1.72B 24 层 Bloom 模型，隐藏维度为 2048。在 45 种自然语言和 12 种编程语言上训练。
bloomz_1.7b_multi 1.72B 24 层 Bloom 模型，隐藏维度为 2048。在跨语言任务混合 (xP3) 数据集上微调。
bloom_3b_multi 3.00B 30 层 Bloom 模型，隐藏维度为 2560。在 45 种自然语言和 12 种编程语言上训练。
bloomz_3b_multi 3.00B 30 层 Bloom 模型，隐藏维度为 2560。在跨语言任务混合 (xP3) 数据集上微调。
falcon_refinedweb_1b_en 1.31B 24 层 Falcon 模型（具有 10 亿参数的 Falcon），在 350B tokens 的 RefinedWeb 数据集上训练。
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 模型。
gpt2_base_en 124.44M 12 层 GPT-2 模型，其中保留了大小写。在 WebText 上训练。
gpt2_base_en_cnn_dailymail 124.44M 12 层 GPT-2 模型，其中保留了大小写。在 CNN/DailyMail 摘要数据集上微调。
gpt2_medium_en 354.82M 24 层 GPT-2 模型，其中保留了大小写。在 WebText 上训练。
gpt2_large_en 774.03M 36 层 GPT-2 模型，其中保留了大小写。在 WebText 上训练。
gpt2_extra_large_en 1.56B 48 层 GPT-2 模型，其中保留了大小写。在 WebText 上训练。
llama2_7b_en 6.74B 70 亿参数，32 层，基础 LLaMA 2 模型。
llama2_instruct_7b_en 6.74B 70 亿参数，32 层，指令调优 LLaMA 2 模型。
vicuna_1.5_7b_en 6.74B 70 亿参数，32 层，指令调优 Vicuna v1.5 模型。
llama2_7b_en_int8 6.74B 70 亿参数，32 层，基础 LLaMA 2 模型，激活和权重量化为 int8。
llama2_instruct_7b_en_int8 6.74B 70 亿参数，32 层，指令调优 LLaMA 2 模型，激活和权重量化为 int8。
llama3_8b_en 8.03B 80 亿参数，32 层，基础 LLaMA 3 模型。
llama3_instruct_8b_en 8.03B 80 亿参数，32 层，指令调优 LLaMA 3 模型。
llama3_8b_en_int8 8.03B 80 亿参数，32 层，基础 LLaMA 3 模型，激活和权重量化为 int8。
llama3_instruct_8b_en_int8 8.03B 80 亿参数，32 层，指令调优 LLaMA 3 模型，激活和权重量化为 int8。
mistral_7b_en 7.24B Mistral 7B 基础模型
mistral_instruct_7b_en 7.24B Mistral 7B 指令模型
mistral_0.2_instruct_7b_en 7.24B Mistral 7B 指令模型 0.2 版本
opt_125m_en 125.24M 12 层 OPT 模型，其中保留了大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_1.3b_en 1.32B 24 层 OPT 模型，其中保留了大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_2.7b_en 2.70B 32 层 OPT 模型，其中保留了大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_6.7b_en 6.70B 32 层 OPT 模型，其中保留了大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
pali_gemma_3b_mix_224 2.92B 图像尺寸 224，混合微调，文本序列长度为 256
pali_gemma_3b_224 2.92B 图像尺寸 224，预训练，文本序列长度为 128
pali_gemma_3b_mix_448 2.92B 图像尺寸 448，混合微调，文本序列长度为 512
pali_gemma_3b_448 2.92B 图像尺寸 448，预训练，文本序列长度为 512
pali_gemma_3b_896 2.93B 图像尺寸 896，预训练，文本序列长度为 512
pali_gemma2_mix_3b_224 3.03B 30 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_pt_3b_224 3.03B 30 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在数据集混合上进行了预训练。
pali_gemma_2_ft_docci_3b_448 3.03B 30 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在 DOCCI 数据集上进行了微调，以改进具有精细细节的描述。
pali_gemma2_mix_3b_448 3.03B 30 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_pt_3b_448 3.03B 30 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_pt_3b_896 3.04B 30 亿参数，图像尺寸 896，SigLIP-So400m 视觉编码器为 27 层，Gemma2 2B 语言模型为 26 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_mix_10b_224 9.66B 100 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_pt_10b_224 9.66B 100 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_ft_docci_10b_448 9.66B 100 亿参数，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在 DOCCI 数据集上进行了微调，以改进具有精细细节的描述。
pali_gemma2_mix_10b_448 9.66B 100 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_pt_10b_448 9.66B 100 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_pt_10b_896 9.67B 100 亿参数，图像尺寸 896，SigLIP-So400m 视觉编码器为 27 层，Gemma2 9B 语言模型为 42 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_mix_28b_224 27.65B 280 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 27B 语言模型为 46 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_mix_28b_448 27.65B 280 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 27B 语言模型为 46 层。此模型已在各种视觉语言任务和领域上进行了微调。
pali_gemma2_pt_28b_224 27.65B 280 亿参数，图像尺寸 224，SigLIP-So400m 视觉编码器为 27 层，Gemma2 27B 语言模型为 46 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_pt_28b_448 27.65B 280 亿参数，图像尺寸 448，SigLIP-So400m 视觉编码器为 27 层，Gemma2 27B 语言模型为 46 层。此模型已在数据集混合上进行了预训练。
pali_gemma2_pt_28b_896 27.65B 280 亿参数，图像尺寸 896，SigLIP-So400m 视觉编码器为 27 层，Gemma2 27B 语言模型为 46 层。此模型已在数据集混合上进行了预训练。
phi3_mini_4k_instruct_en 3.82B 38 亿参数，32 层，4k 上下文长度，Phi-3 模型。该模型使用 Phi-3 数据集进行训练。该数据集包括合成数据和经过滤的公开网站数据，重点关注高质量和推理密集型属性。
phi3_mini_128k_instruct_en 3.82B 38 亿参数，32 层，128k 上下文长度，Phi-3 模型。该模型使用 Phi-3 数据集进行训练。该数据集包括合成数据和经过滤的公开网站数据，重点关注高质量和推理密集型属性。

[source]

save_to_preset 方法

CausalLMPreprocessor.save_to_preset(preset_dir)

将预处理器保存到预设目录。

参数

  • preset_dir: 本地模型预设目录的路径。

tokenizer 属性

keras_hub.models.CausalLMPreprocessor.tokenizer

用于标记化字符串的分词器。

CausalLMPreprocessor
CausalLMPreprocessor 类
from_preset 方法
save_to_preset 方法
tokenizer 属性