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

MaskedLMPreprocessor

[来源]

MaskedLMPreprocessor

keras_nlp.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_nlp.tokenizer.Tokenizer,以创建一个用于掩码语言模型任务的预处理层。它旨在与 keras.models.MaskedLM 任务配对。

所有 MaskedLMPreprocessor 都接受单个输入。这可以是单个字符串、一批字符串,或者应该组合成单个序列的一批字符串片段的元组。请参阅下面的示例。这些输入将被分词、组合并在序列中随机掩码。

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

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

示例。

preprocessor = keras_nlp.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, **kwargs)

从模型预设中实例化一个 keras_nlp.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_nlp.models.BertTextClassifierPreprocessor.from_preset()

参数

  • preset: 字符串。一个内置的预设标识符、一个 Kaggle 模型句柄、一个 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",
)

[来源]

save_to_preset 方法

MaskedLMPreprocessor.save_to_preset(preset_dir)

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

参数

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

tokenizer 属性

keras_nlp.models.MaskedLMPreprocessor.tokenizer

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