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

MaskedLMPreprocessor

[源代码]

MaskedLMPreprocessor

keras_hub.models.MaskedLMPreprocessor(
    tokenizer,
    sequence_length=512,
    truncate="round_robin",
    mask_selection_rate=0.15,
    mask_selection_length=96,
    mask_token_rate=0.8,
    random_token_rate=0.1,
    **kwargs
)

掩码语言建模预处理层的基类。

MaskedLMPreprocessor 任务包装一个 keras_hub.tokenizer.Tokenizer,为掩码语言建模任务创建一个预处理层。它旨在与 keras.models.MaskedLM 任务配对。

所有 MaskedLMPreprocessor 接收单个输入。这可以是单个字符串、字符串批次,或应组合成单个序列的字符串片段批次元组。请参见下面的示例。这些输入将被分词、组合并沿序列随机掩码。

此层将始终输出一个 (x, y, sample_weight) 元组,其中 x 是包含掩码分词输入的字典,y 包含 x 中被掩码的词元,sample_weight 标记 y 中包含填充值的位置。x 的确切内容将根据使用的模型而异。

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

示例。

preprocessor = keras_hub.models.MaskedLMPreprocessor.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)

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

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

[源代码]

from_preset 方法

MaskedLMPreprocessor.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.GemmaCausalLMPreprocessor.from_preset(
    "gemma_2b_en",
)

# Load a preprocessor for Bert classification.
preprocessor = keras_hub.models.BertTextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设名称 参数 描述
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 主干模型。
xlm_roberta_base_multi 277.45M 保留大小写的 12 层 XLM-RoBERTa 模型。在 100 种语言的 CommonCrawl 上训练。
xlm_roberta_large_multi 558.84M 保留大小写的 24 层 XLM-RoBERTa 模型。在 100 种语言的 CommonCrawl 上训练。
f_net_base_en 82.86M 保留大小写的 12 层 FNet 模型。在 C4 数据集上训练。
f_net_large_en 236.95M 保留大小写的 24 层 FNet 模型。在 C4 数据集上训练。
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 数据集上训练。
roberta_base_en 124.05M 保留大小写的 12 层 RoBERTa 模型。在英语维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
roberta_large_en 354.31M 保留大小写的 24 层 RoBERTa 模型。在英语维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
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 种语言的维基百科上训练
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 上训练。

[源代码]

save_to_preset 方法

MaskedLMPreprocessor.save_to_preset(preset_dir)

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

参数

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

tokenizer 属性

keras_hub.models.MaskedLMPreprocessor.tokenizer

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