Keras 3 API 文档 / KerasHub / 模型 API / TextClassifierPreprocessor

TextClassifierPreprocessor

[来源]

TextClassifierPreprocessor

keras_hub.models.TextClassifierPreprocessor(
    tokenizer, sequence_length=512, truncate="round_robin", **kwargs
)

文本分类预处理层的基类。

TextClassifierPreprocessor 任务封装了一个 keras_hub.tokenizer.Tokenizer,为文本分类任务创建了一个预处理层。它旨在与 keras_hub.models.TextClassifier 任务配对。

所有 TextClassifierPreprocessor 都接受三个有序输入,xysample_weightx 是第一个输入,应该始终包含。它可以是一个字符串、一批字符串,或者是一个字符串段批次的元组,这些字符串段批次应该组合成一个单一序列。请参阅下面的示例。 ysample_weight 是可选输入,将原样传递。通常,y 将是分类标签,sample_weight 将不会提供。

该层将输出 x、如果提供了标签则输出 (x, y) 元组,或者如果提供了标签和样本权重则输出 (x, y, sample_weight) 元组。 x 将是一个包含标记化输入的字典,字典的确切内容将取决于使用的模型。

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

示例。

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

# Tokenize and pad/truncate a single sentence.
x = "The quick brown fox jumped."
x = preprocessor(x)

# Tokenize and pad/truncate a labeled sentence.
x, y = "The quick brown fox jumped.", 1
x, y = preprocessor(x, y)

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

# Tokenize and combine a batch of labeled sentence pairs.
first = ["The quick brown fox jumped.", "Call me Ishmael."]
second = ["The fox tripped.", "Oh look, a whale."]
labels = [1, 0]
x, y = (first, second), labels
x, y = preprocessor(x, y)

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

[来源]

from_preset 方法

TextClassifierPreprocessor.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: string。内置预设标识符、Kaggle 模型句柄、Hugging Face 句柄或本地目录的路径。

示例

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

# Load a preprocessor for Bert classification.
preprocessor = keras_hub.models.BertTextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设名称 参数 描述
f_net_base_en 82.86M 12 层 FNet 模型,其中保留大小写。在 C4 数据集上训练。
f_net_large_en 236.95M 24 层 FNet 模型,其中保留大小写。在 C4 数据集上训练。
bert_tiny_en_uncased 4.39M 2 层 BERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
bert_small_en_uncased 28.76M 4 层 BERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
bert_medium_en_uncased 41.37M 8 层 BERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_en_uncased 109.48M 12 层 BERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_en 108.31M 12 层 BERT 模型,其中保留大小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_zh 102.27M 12 层 BERT 模型。在中文维基百科上训练。
bert_base_multi 177.85M 12 层 BERT 模型,其中保留大小写。在 104 种语言的维基百科上训练。
bert_large_en_uncased 335.14M 24 层 BERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
bert_large_en 333.58M 24 层 BERT 模型,其中保留大小写。在英文维基百科 + BooksCorpus 上训练。
bert_tiny_en_uncased_sst2 4.39M 在 SST-2 情感分析数据集上微调的 bert_tiny_en_uncased 主干模型。
distil_bert_base_en_uncased 66.36M 6 层 DistilBERT 模型,其中所有输入都转换为小写。使用 BERT 作为教师模型在英文维基百科 + BooksCorpus 上训练。
distil_bert_base_en 65.19M 6 层 DistilBERT 模型,其中保留大小写。使用 BERT 作为教师模型在英文维基百科 + BooksCorpus 上训练。
distil_bert_base_multi 134.73M 6 层 DistilBERT 模型,其中保留大小写。在 104 种语言的维基百科上训练。
roberta_base_en 124.05M 12 层 RoBERTa 模型,其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
roberta_large_en 354.31M 24 层 RoBERTa 模型,其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
xlm_roberta_base_multi 277.45M 12 层 XLM-RoBERTa 模型,其中保留大小写。在 100 种语言的 CommonCrawl 上训练。
xlm_roberta_large_multi 558.84M 24 层 XLM-RoBERTa 模型,其中保留大小写。在 100 种语言的 CommonCrawl 上训练。
albert_base_en_uncased 11.68M 12 层 ALBERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
albert_large_en_uncased 17.68M 24 层 ALBERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
albert_extra_large_en_uncased 58.72M 24 层 ALBERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
albert_extra_extra_large_en_uncased 222.60M 12 层 ALBERT 模型,其中所有输入都转换为小写。在英文维基百科 + BooksCorpus 上训练。
deberta_v3_extra_small_en 70.68M 12 层 DeBERTaV3 模型,其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_small_en 141.30M 6 层 DeBERTaV3 模型,其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_en 183.83M 12 层 DeBERTaV3 模型,其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_large_en 434.01M 24 层 DeBERTaV3 模型,其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_multi 278.22M 12 层 DeBERTaV3 模型,其中保留大小写。在 2.5TB 多语言 CC100 数据集上训练。

[来源]

save_to_preset 方法

TextClassifierPreprocessor.save_to_preset(preset_dir)

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

参数

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

tokenizer 属性

keras_hub.models.TextClassifierPreprocessor.tokenizer

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