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

XLMRobertaTextClassifierPreprocessor 层

[源代码]

XLMRobertaTextClassifierPreprocessor

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

一个 XLM-RoBERTa 预处理层,用于对输入进行分词和打包。

此预处理层将执行三个操作

  1. 使用 tokenizer 对任意数量的输入段进行分词。
  2. 使用 keras_hub.layers.MultiSegmentPacker 将输入打包在一起,并添加适当的 "<s>""</s>""<pad>" 标记。具体来说,在整个序列的开头添加一个 "<s>",在每个段的末尾(最后一个段除外)添加 "</s></s>",并在整个序列的末尾添加一个 "</s>"
  3. 构建一个包含键 "token_ids""padding_mask" 的字典,可以直接将其传递给 XLM-RoBERTa 模型。

此层可以直接与 tf.data.Dataset.map 配合使用,以按 keras.Model.fit 使用的 (x, y, sample_weight) 格式预处理字符串数据。

参数

  • tokenizer:一个 keras_hub.tokenizers.XLMRobertaTokenizer 实例。
  • sequence_length:打包输入的长度。
  • truncate:截断批量段列表以适应 sequence_length 的算法。值可以是 round_robinwaterfall:- "round_robin":可用空间以轮询(round-robin)方式每次分配一个标记给仍然需要的输入,直到达到限制。- "waterfall":预算分配使用“瀑布”(waterfall)算法完成,该算法以从左到右的方式分配配额,并填充桶直到预算用尽。它支持任意数量的段。

调用参数

  • x:单个字符串序列的张量,或要打包在一起的多个张量序列的元组。输入可以是批量或非批量的。对于单个序列,原始 python 输入将被转换为张量。对于多个序列,直接传递张量。
  • y:任何标签数据。将原样传递。
  • sample_weight:任何标签权重数据。将原样传递。

示例

直接在数据上调用层。

preprocessor = keras_hub.models.TextClassifierPreprocessor.from_preset(
    "xlm_roberta_base_multi"
)

# Tokenize and pack a single sentence.
preprocessor("The quick brown fox jumped.")

# Tokenize a batch of single sentences.
preprocessor(["The quick brown fox jumped.", "اسمي اسماعيل"])

# Preprocess a batch of sentence pairs.
# When handling multiple sequences, always convert to tensors first!
first = tf.constant(["The quick brown fox jumped.", "اسمي اسماعيل"])
second = tf.constant(["The fox tripped.", "الأسد ملك الغابة"])
preprocessor((first, second))

# Custom vocabulary.
def train_sentencepiece(ds, vocab_size):
    bytes_io = io.BytesIO()
    sentencepiece.SentencePieceTrainer.train(
        sentence_iterator=ds.as_numpy_iterator(),
        model_writer=bytes_io,
        vocab_size=vocab_size,
        model_type="WORD",
        unk_id=0,
        bos_id=1,
        eos_id=2,
    )
    return bytes_io.getvalue()
ds = tf.data.Dataset.from_tensor_slices(
    ["the quick brown fox", "the earth is round"]
)
proto = train_sentencepiece(ds, vocab_size=10)
tokenizer = keras_hub.models.XLMRobertaTokenizer(proto=proto)
preprocessor = keras_hub.models.XLMRobertaTextClassifierPreprocessor(
    tokenizer
)
preprocessor("The quick brown fox jumped.")

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

preprocessor = keras_hub.models.TextClassifierPreprocessor.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."])
label = tf.constant([1, 1])

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

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

# Map labeled sentence pairs.
ds = tf.data.Dataset.from_tensor_slices(((first, second), label))
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Map unlabeled 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,
)

[源代码]

from_preset 方法

XLMRobertaTextClassifierPreprocessor.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 模型,保持大小写。在 CommonCrawl 的 100 种语言上训练。
xlm_roberta_large_multi 558.84M 一个 24 层的 XLM-RoBERTa 模型,保持大小写。在 CommonCrawl 的 100 种语言上训练。

tokenizer 属性

keras_hub.models.XLMRobertaTextClassifierPreprocessor.tokenizer

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