Keras 3 API 文档 / KerasNLP / 预训练模型 / Roberta / RobertaTextClassifierPreprocessor 层

RobertaTextClassifierPreprocessor 层

[源代码]

RobertaTextClassifierPreprocessor

keras_nlp.models.RobertaTextClassifierPreprocessor(
    tokenizer, sequence_length=512, truncate="round_robin", **kwargs
)

一个 RoBERTa 预处理层,用于分词和打包输入。

此预处理层将执行以下三项操作

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

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

参数

  • tokenizer:一个 keras_nlp.models.RobertaTokenizer 实例。
  • sequence_length:打包输入的长度。
  • truncate:字符串。将一批分段列表截断以适合 sequence_length 的算法。该值可以是 round_robinwaterfall
    • "round_robin":可用的空间将以循环方式一次分配一个标记给仍然需要某些空间的输入,直到达到限制。
    • "waterfall":预算的分配使用“瀑布”算法完成,该算法以从左到右的方式分配配额,并填充分配桶,直到预算用完。它支持任意数量的片段。

调用参数

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

示例

直接在数据上调用该层。

preprocessor = keras_nlp.models.TextClassifierPreprocessor.from_preset(
    "roberta_base_en"
)

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

# Tokenize a batch of single sentences.
preprocessor(["The quick brown fox jumped.", "Call me Ishmael."])

# Preprocess a batch of sentence pairs.
# When handling multiple sequences, always convert to tensors first!
first = tf.constant(["The quick brown fox jumped.", "Call me Ishmael."])
second = tf.constant(["The fox tripped.", "Oh look, a whale."])
preprocessor((first, second))

# Custom vocabulary.
vocab = {"<s>": 0, "<pad>": 1, "</s>": 2, "<mask>": 3}
vocab = {**vocab, "a": 4, "Ġquick": 5, "Ġfox": 6}
merges = ["Ġ q", "u i", "c k", "ui ck", "Ġq uick", "Ġ f", "o x", "Ġf ox"]
tokenizer = keras_nlp.models.RobertaTokenizer(
    vocabulary=vocab,
    merges=merges
)
preprocessor = keras_nlp.models.RobertaTextClassifierPreprocessor(tokenizer)
preprocessor("a quick fox")

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

preprocessor = keras_nlp.models.TextClassifierPreprocessor.from_preset(
    "roberta_base_en"
)

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 方法

RobertaTextClassifierPreprocessor.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",
)
预设名称 参数 描述
roberta_base_en 124.05M 12 层 RoBERTa 模型,其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
roberta_large_en 354.31M 24 层 RoBERTa 模型,其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。

tokenizer 属性

keras_nlp.models.RobertaTextClassifierPreprocessor.tokenizer

用于分词字符串的分词器。