KerasHub: 预训练模型 / API 文档 / 模型架构 / XLMRoberta / XLMRobertaMaskedLMPreprocessor 层

XLMRobertaMaskedLMPreprocessor 层

[源代码]

XLMRobertaMaskedLMPreprocessor

keras_hub.models.XLMRobertaMaskedLMPreprocessor(
    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
)

用于掩码语言建模任务的 XLM-RoBERTa 预处理。

此预处理层将为掩码语言建模任务准备输入。它主要用于 keras_hub.models.XLMRobertaMaskedLM 任务模型。预处理将分多个步骤进行。

  1. 使用 tokenizer 对任意数量的输入段进行分词。
  2. 将输入与适当的 "<s>""</s>""<pad>" 标记打包在一起,即在整个序列的开头添加单个 "<s>",在每个段之间添加 "</s></s>",并在整个序列的末尾添加 "</s>"
  3. 随机选择非特殊标记进行掩码,由 mask_selection_rate 控制。
  4. 构建适合使用 keras_hub.models.XLMRobertaMaskedLM 任务模型训练的 (x, y, sample_weight) 元组。

参数

  • tokenizer:一个 keras_hub.models.XLMRobertaTokenizer 实例。
  • sequence_length: int. 打包输入的长度。
  • truncate:字符串。用于将分批的段列表截断以适应 sequence_length 的算法。该值可以是 round_robinwaterfall: - "round_robin":可用空间以轮询方式一次分配一个标记给仍然需要一些输入的输入,直到达到限制。 - "waterfall":预算的分配使用“瀑布”算法完成,该算法以从左到右的方式分配配额,并填充桶,直到我们用完预算。它支持任意数量的段。
  • mask_selection_rate: float. 输入标记被动态掩码的概率。
  • mask_selection_length: int. 给定样本中掩码标记的最大数量。
  • mask_token_rate: float. 选定标记被掩码标记替换的概率。
  • random_token_rate: float. 选定标记被词汇表中随机标记替换的概率。选定标记保持不变的概率为 1 - mask_token_rate - random_token_rate

调用参数

  • x:单个字符串序列的张量,或多个要打包在一起的张量序列的元组。输入可以是批处理的或非批处理的。对于单个序列,原始 Python 输入将转换为张量。对于多个序列,直接传递张量。
  • y:标签数据。应始终为 None,因为该层会生成标签。
  • sample_weight:标签权重。应始终为 None,因为该层会生成标签权重。

示例

直接在数据上调用该层。

# Load the preprocessor from a preset.
preprocessor = keras_hub.models.XLMRobertaMaskedLMPreprocessor.from_preset(
    "xlm_roberta_base_multi"
)

# Tokenize and mask a single sentence.
preprocessor("The quick brown fox jumped.")
# Tokenize and mask a batch of single sentences.
preprocessor(["The quick brown fox jumped.", "Call me Ishmael."])
# Tokenize and mask sentence pairs.
# In this case, always convert input to tensors before calling the layer.
first = tf.constant(["The quick brown fox jumped.", "Call me Ishmael."])
second = tf.constant(["The fox tripped.", "Oh look, a whale."])
preprocessor((first, second))

使用 tf.data.Dataset 进行映射。

preprocessor = keras_hub.models.XLMRobertaMaskedLMPreprocessor.from_preset(
    "xlm_roberta_base_multi"
)
first = tf.constant(["The quick brown fox jumped.", "Call me Ishmael."])
second = tf.constant(["The fox tripped.", "Oh look, a whale."])

# Map single sentences.
ds = tf.data.Dataset.from_tensor_slices(first)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Map sentence pairs.
ds = tf.data.Dataset.from_tensor_slices((first, second))
# Watch out for tf.data's default unpacking of tuples here!
# Best to invoke the `preprocessor` directly in this case.
ds = ds.map(
    lambda first, second: preprocessor(x=(first, second)),
    num_parallel_calls=tf.data.AUTOTUNE,
)
----

<span style="float:right;">[[source]](https://github.com/keras-team/keras-hub/tree/v0.21.1/keras_hub/src/models/preprocessor.py#L132)</span>

### `from_preset` method


```python
XLMRobertaMaskedLMPreprocessor.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",
)
预设 参数 描述
xlm_roberta_base_multi 277.45M 12 层 XLM-RoBERTa 模型,大小写保持不变。在 100 种语言的 CommonCrawl 上训练。
xlm_roberta_large_multi 558.84M 24 层 XLM-RoBERTa 模型,大小写保持不变。在 100 种语言的 CommonCrawl 上训练。

tokenizer 属性

keras_hub.models.XLMRobertaMaskedLMPreprocessor.tokenizer

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