KerasHub: 预训练模型 / API 文档 / 模型 API / CausalLMPreprocessor

CausalLMPreprocessor

[源文件]

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 的 token,sample_weight 标记 y 包含填充值的位置。x 的具体内容将根据使用的模型而变化。

一个 CausalLMPreprocessor 包含两个额外的方法,generate_preprocessgenerate_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.

[源文件]

from_preset 方法

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

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

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

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

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

参数

  • preset:字符串。内置预设标识符、Kaggle 模型句柄、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 模型 (拥有 1B 参数的 Falcon),在 350B token 的 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 模型。
gemma3_1b 999.89M 10 亿参数,26 层,仅文本预训练 Gemma3 模型。
gemma3_instruct_1b 999.89M 10 亿参数,26 层,仅文本指令微调 Gemma3 模型。
gemma3_4b_text 3.88B 40 亿参数,34 层,仅文本预训练 Gemma3 模型。
gemma3_instruct_4b_text 3.88B 40 亿参数,34 层,仅文本指令微调 Gemma3 模型。
gemma3_4b 4.30B 40 亿参数,34 层,视觉+文本预训练 Gemma3 模型。
gemma3_instruct_4b 4.30B 40 亿参数,34 层,视觉+文本指令微调 Gemma3 模型。
gemma3_12b_text 11.77B 120 亿参数,48 层,仅文本预训练 Gemma3 模型。
gemma3_instruct_12b_text 11.77B 120 亿参数,48 层,仅文本指令微调 Gemma3 模型。
gemma3_12b 12.19B 120 亿参数,48 层,视觉+文本预训练 Gemma3 模型。
gemma3_instruct_12b 12.19B 120 亿参数,48 层,视觉+文本指令微调 Gemma3 模型。
gemma3_27b_text 27.01B 270 亿参数,62 层,仅文本预训练 Gemma3 模型。
gemma3_instruct_27b_text 27.01B 270 亿参数,62 层,仅文本指令微调 Gemma3 模型。
gemma3_27b 27.43B 270 亿参数,62 层,视觉+文本预训练 Gemma3 模型。
gemma3_instruct_27b 27.43B 270 亿参数,62 层,视觉+文本指令微调 Gemma3 模型。
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 数据集训练。该数据集包含合成数据和过滤后的公开网站数据,重点关注高质量和推理密集特性。
siglip_base_patch16_224 203.16M 2 亿参数,图像尺寸 224,在 WebLi 上预训练。
siglip_base_patch16_256 203.20M 2 亿参数,图像尺寸 256,在 WebLi 上预训练。
siglip_base_patch16_384 203.45M 2 亿参数,图像尺寸 384,在 WebLi 上预训练。
siglip_base_patch16_512 203.79M 2 亿参数,图像尺寸 512,在 WebLi 上预训练。
siglip_base_patch16_256_multilingual 370.63M 3.7 亿参数,图像尺寸 256,在 WebLi 上预训练。
siglip2_base_patch16_224 375.19M 3.75 亿参数,Patch 尺寸 16,图像尺寸 224,在 WebLi 上预训练。
siglip2_base_patch16_256 375.23M 3.75 亿参数,Patch 尺寸 16,图像尺寸 256,在 WebLi 上预训练。
siglip2_base_patch32_256 376.86M 3.76 亿参数,Patch 尺寸 32,图像尺寸 256,在 WebLi 上预训练。
siglip2_base_patch16_384 376.86M 3.76 亿参数,Patch 尺寸 16,图像尺寸 384,在 WebLi 上预训练。
siglip_large_patch16_256 652.15M 6.52 亿参数,图像尺寸 256,在 WebLi 上预训练。
siglip_large_patch16_384 652.48M 6.52 亿参数,图像尺寸 384,在 WebLi 上预训练。
siglip_so400m_patch14_224 877.36M 8.77 亿参数,图像尺寸 224,形状优化版本,在 WebLi 上预训练。
siglip_so400m_patch14_384 877.96M 8.77 亿参数,图像尺寸 384,形状优化版本,在 WebLi 上预训练。
siglip2_large_patch16_256 881.53M 8.81 亿参数,Patch 尺寸 16,图像尺寸 256,在 WebLi 上预训练。
siglip2_large_patch16_384 881.86M 8.81 亿参数,Patch 尺寸 16,图像尺寸 384,在 WebLi 上预训练。
siglip2_large_patch16_512 882.31M 8.82 亿参数,Patch 尺寸 16,图像尺寸 512,在 WebLi 上预训练。
siglip_so400m_patch16_256_i18n 1.13B 11 亿参数,图像尺寸 256,形状优化版本,在 WebLi 上预训练。
siglip2_so400m_patch14_224 1.14B 11 亿参数,Patch 尺寸 14,图像尺寸 224,形状优化版本,在 WebLi 上预训练。
siglip2_so400m_patch16_256 1.14B 11 亿参数,Patch 尺寸 16,图像尺寸 256,形状优化版本,在 WebLi 上预训练。
siglip2_so400m_patch14_384 1.14B 11 亿参数,Patch 尺寸 14,图像尺寸 224,形状优化版本,在 WebLi 上预训练。
siglip2_so400m_patch16_384 1.14B 11 亿参数,Patch 尺寸 16,图像尺寸 384,形状优化版本,在 WebLi 上预训练。
siglip2_so400m_patch16_512 1.14B 11 亿参数,Patch 尺寸 16,图像尺寸 512,形状优化版本,在 WebLi 上预训练。
siglip2_giant_opt_patch16_256 1.87B 18 亿参数,Patch 尺寸 16,图像尺寸 256,在 WebLi 上预训练。
siglip2_giant_opt_patch16_384 1.87B 18 亿参数,Patch 尺寸 16,图像尺寸 384,在 WebLi 上预训练。

[源文件]

save_to_preset 方法

CausalLMPreprocessor.save_to_preset(preset_dir)

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

参数

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

tokenizer 属性

keras_hub.models.CausalLMPreprocessor.tokenizer

用于对字符串进行分词的分词器。