Keras 3 API 文档 / KerasNLP / 预训练模型 / Bart / BartSeq2SeqLMPreprocessor 层

BartSeq2SeqLMPreprocessor 层

[源代码]

BartSeq2SeqLMPreprocessor

keras_nlp.models.BartSeq2SeqLMPreprocessor(
    tokenizer, encoder_sequence_length=1024, decoder_sequence_length=1024, **kwargs
)

BART Seq2Seq LM 预处理器。

此层用作使用 BART 模型的 seq2seq 任务的预处理器。此类是 keras_nlp.models.BartPreprocessor 的子类,保留了其大部分功能。它与超类有两个区别

  1. 通过将解码器输入序列向左移动一步来设置 y(标签)和 sample_weights 字段。这两个字段都是内部推断的,任何传递的值都将被忽略。
  2. 从解码器输入序列中删除最后一个标记,因为它没有后继者。

参数

  • tokenizer: 一个 keras_nlp.models.BartTokenizer 实例。
  • encoder_sequence_length: 打包的编码器输入的长度。
  • decoder_sequence_length: 打包的解码器输入的长度。

调用参数

  • x: 一个字典,其中 encoder_textdecoder_text 作为其键。字典中的每个值都应该是单个字符串序列的张量。输入可以是批处理的或非批处理的。原始 Python 输入将被转换为张量。
  • y: 标签数据。应该始终为 None,因为该层通过将解码器输入序列向左移动一步来生成标签。
  • sample_weight: 标签权重。应该始终为 None,因为该层通过将填充掩码向左移动一步来生成标签权重。

示例

直接在数据上调用该层

preprocessor = keras_nlp.models.BartPreprocessor.from_preset("bart_base_en")

# Preprocess unbatched inputs.
inputs = {
    "encoder_text": "The fox was sleeping.",
    "decoder_text": "The fox was awake."
}
preprocessor(inputs)

# Preprocess batched inputs.
inputs = {
    "encoder_text": ["The fox was sleeping.", "The lion was quiet."],
    "decoder_text": ["The fox was awake.", "The lion was roaring."]
}
preprocessor(inputs)

# Custom vocabulary.
vocab = {
    "<s>": 0,
    "<pad>": 1,
    "</s>": 2,
    "Ġafter": 5,
    "noon": 6,
    "Ġsun": 7,
}
merges = ["Ġ a", "Ġ s", "Ġ n", "e r", "n o", "o n", "Ġs u", "Ġa f", "no on"]
merges += ["Ġsu n", "Ġaf t", "Ġaft er"]

tokenizer = keras_nlp.models.BartTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_nlp.models.BartPreprocessor(
    tokenizer=tokenizer,
    encoder_sequence_length=20,
    decoder_sequence_length=10,
)
inputs = {
    "encoder_text": "The fox was sleeping.",
    "decoder_text": "The fox was awake."
}
preprocessor(inputs)

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

preprocessor = keras_nlp.models.BartPreprocessor.from_preset("bart_base_en")

# Map single sentences.
features = {
    "encoder_text": tf.constant(
        ["The fox was sleeping.", "The lion was quiet."]
    ),
    "decoder_text": tf.constant(
        ["The fox was awake.", "The lion was roaring."]
    )
}
ds = tf.data.Dataset.from_tensor_slices(features)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

[源代码]

from_preset 方法

BartSeq2SeqLMPreprocessor.from_preset(preset, **kwargs)

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

参数

  • preset: 字符串。一个内置预设标识符,一个 Kaggle Models 句柄,一个 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",
)
预设名称 参数 描述
bart_base_en 139.42M 6 层 BART 模型,保持大小写。在 BookCorpus、英文维基百科和 CommonCrawl 上训练。
bart_large_en 406.29M 12 层 BART 模型,保持大小写。在 BookCorpus、英文维基百科和 CommonCrawl 上训练。
bart_large_en_cnn 406.29M 在 CNN+DM 摘要数据集上微调的 bart_large_en 主干模型。

[源代码]

generate_preprocess 方法

BartSeq2SeqLMPreprocessor.generate_preprocess(
    x, encoder_sequence_length=None, decoder_sequence_length=None, sequence_length=None
)

将编码器和解码器输入字符串转换为用于生成的整型标记输入。

类似于为训练调用该层,此方法接收包含 "encoder_text""decoder_text" 的字典,其值为字符串或张量字符串,对输入进行分词和打包,并计算一个填充掩码,该掩码掩盖所有未用填充值填充的输入。

与为训练调用该层不同,此方法不会计算标签,并且永远不会在解码器序列末尾附加分词器 end_token_id(因为预期生成将从输入的解码器提示的末尾继续)。


[源代码]

generate_postprocess 方法

BartSeq2SeqLMPreprocessor.generate_postprocess(x)

将整型标记输出转换为用于生成的字符串。

此方法反转 generate_preprocess(),首先移除所有填充和开始/结束标记,然后将整型序列转换回字符串。


tokenizer 属性

keras_nlp.models.BartSeq2SeqLMPreprocessor.tokenizer

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