Transformers 文档

BART

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验的访问权限

开始使用

BART

Models Spaces

概述

Bart 模型在 BART: 用于自然语言生成、翻译和理解的去噪序列到序列预训练 中提出,作者为 Mike Lewis、Yinhan Liu、Naman Goyal、Marjan Ghazvininejad、Abdelrahman Mohamed、Omer Levy、Ves Stoyanov 和 Luke Zettlemoyer,发布于 2019 年 10 月 29 日。

根据摘要内容,

  • Bart 使用标准的 seq2seq/机器翻译架构,包含一个双向编码器(如 BERT)和一个从左到右的解码器(如 GPT)。
  • 预训练任务包括随机打乱原始句子的顺序,以及一种新颖的填充方案,其中文本片段被替换为单个掩码标记。
  • BART 在微调到文本生成时特别有效,但对于理解任务也效果很好。在 GLUE 和 SQuAD 上,它在可比的训练资源上与 RoBERTa 的性能相匹配,在各种抽象对话、问答和摘要任务上取得了新的最先进的结果, ROUGE 的提升幅度高达 6%。

该模型由 sshleifer 贡献。作者的代码可以在 此处 找到。

使用技巧:

  • BART 是一个具有绝对位置嵌入的模型,因此通常建议在右侧而不是左侧填充输入。

  • 具有编码器和解码器的序列到序列模型。编码器接收标记的损坏版本,解码器接收原始标记(但有一个掩码来隐藏未来的单词,就像一个普通的 transformers 解码器)。在预训练任务中对编码器应用以下变换的组合

    • 掩码随机标记(如 BERT 中一样)
    • 删除随机标记
    • 用单个掩码标记掩码 k 个标记的跨度(0 个标记的跨度是插入掩码标记)
    • 置换句子
    • 旋转文档使其从特定标记开始

实现说明

  • Bart 不使用 token_type_ids 进行序列分类。使用 BartTokenizerencode() 获取正确的拆分。
  • BartModel 的前向传递将创建 decoder_input_ids(如果它们未传递)。这与其他一些建模 API 不同。此功能的典型用例是掩码填充。
  • forced_bos_token_id=0 时,模型预测应与原始实现相同。但是,这只有在传递给 fairseq.encode 的字符串以空格开头时才有效。
  • generate() 应该用于条件生成任务,如摘要,请参阅该文档字符串中的示例。
  • 加载 facebook/bart-large-cnn 权重的模型将没有 mask_token_id 或无法执行掩码填充任务。

掩码填充

facebook/bart-basefacebook/bart-large 检查点可用于填充多标记掩码。

from transformers import BartForConditionalGeneration, BartTokenizer

model = BartForConditionalGeneration.from_pretrained("facebook/bart-large", forced_bos_token_id=0)
tok = BartTokenizer.from_pretrained("facebook/bart-large")
example_english_phrase = "UN Chief Says There Is No <mask> in Syria"
batch = tok(example_english_phrase, return_tensors="pt")
generated_ids = model.generate(batch["input_ids"])
assert tok.batch_decode(generated_ids, skip_special_tokens=True) == [
    "UN Chief Says There Is No Plan to Stop Chemical Weapons in Syria"
]

资源

一系列官方 Hugging Face 和社区(由🌎表示)资源,可帮助您开始使用 BART。如果您有兴趣提交要包含在此处的资源,请随时打开拉取请求,我们会对其进行审核!该资源理想情况下应展示一些新内容,而不是重复现有资源。

摘要
填补掩码
翻译

另请参阅

BartConfig

class transformers.BartConfig

< >

( vocab_size = 50265 max_position_embeddings = 1024 encoder_layers = 12 encoder_ffn_dim = 4096 encoder_attention_heads = 16 decoder_layers = 12 decoder_ffn_dim = 4096 decoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 activation_function = 'gelu' d_model = 1024 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 classifier_dropout = 0.0 scale_embedding = False use_cache = True num_labels = 3 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 is_encoder_decoder = True decoder_start_token_id = 2 forced_eos_token_id = 2 **kwargs )

参数

  • vocab_size (int, 可选, 默认值 50265) — BART 模型的词汇量。定义了在调用 BartModelTFBartModel 时,可以通过 inputs_ids 表示的不同标记的数量。
  • d_model (int, 可选, 默认值 1024) — 层和池化层的维度。
  • encoder_layers (int, 可选, 默认值 12) — 编码器层数。
  • decoder_layers (int, 可选, 默认值 12) — 解码器层数。
  • 编码器注意力头数 (int, 可选, 默认为 16) — 变压器编码器中每个注意力层的注意力头数。
  • 解码器注意力头数 (int, 可选, 默认为 16) — 变压器解码器中每个注意力层的注意力头数。
  • 解码器前馈层维度 (int, 可选, 默认为 4096) — 解码器中“中间”(通常称为前馈)层的维度。
  • 编码器前馈层维度 (int, 可选, 默认为 4096) — 编码器中“中间”(通常称为前馈)层的维度。
  • 激活函数 (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""silu""gelu_new"
  • 丢弃率 (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
  • 注意力丢弃率 (float, 可选, 默认为 0.0) — 注意力概率的丢弃率。
  • 激活丢弃率 (float, 可选, 默认为 0.0) — 全连接层内部激活的丢弃率。
  • 分类器丢弃率 (float, 可选, 默认为 0.0) — 分类器的丢弃率。
  • 最大位置嵌入 (int, 可选, 默认为 1024) — 此模型可能用到的最大序列长度。通常将其设置为一个较大的值以防万一(例如,512 或 1024 或 2048)。
  • encoder_layerdrop (float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。详情请参阅 [LayerDrop 论文](参见 https://arxiv.org/abs/1909.11556)。
  • decoder_layerdrop (float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。详情请参阅 [LayerDrop 论文](参见 https://arxiv.org/abs/1909.11556)。
  • scale_embedding (bool, 可选, 默认为 False) — 通过除以 sqrt(d_model) 来缩放嵌入。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后的键值注意力(并非所有模型都使用)。
  • num_labels (int, 可选, 默认为 3) — 在 BartForSequenceClassification 中使用的标签数量。
  • forced_eos_token_id (int, 可选, 默认为 2) — 当达到 max_length 时,强制作为最后一个生成的令牌的令牌 ID。通常设置为 eos_token_id

这是用于存储 BartModel 配置的配置类。它用于根据指定的参数实例化 BART 模型,定义模型架构。使用默认值实例化配置将产生与 BART facebook/bart-large 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。

示例

>>> from transformers import BartConfig, BartModel

>>> # Initializing a BART facebook/bart-large style configuration
>>> configuration = BartConfig()

>>> # Initializing a model (with random weights) from the facebook/bart-large style configuration
>>> model = BartModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

BartTokenizer

class transformers.BartTokenizer

< >

( vocab_file merges_file errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False **kwargs )

参数

  • vocab_file (str) — 词汇表文件路径。
  • merges_file (str) — 合并文件路径。
  • errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时的解码范例。有关更多信息,请参阅 bytes.decode
  • bos_token (str, 可选, 默认为 "<s>") — 预训练期间使用的序列起始标记。可以用作序列分类标记。

    在使用特殊标记构建序列时,这不是用于序列起始的标记。使用的标记是 cls_token

  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

    在使用特殊标记构建序列时,这不是用于序列结束的标记。使用的标记是 sep_token

  • sep_token (str, 可选, 默认为 "</s>") — 分隔符标记,用于从多个序列构建序列,例如两个用于序列分类的序列,或用于问答的文本和问题。它也用作用特殊标记构建的序列的最后一个标记。
  • cls_token (str, 可选, 默认为 "<s>") — 用于执行序列分类(整个序列的分类,而不是每个标记的分类)的分类标记。它是使用特殊标记构建的序列的第一个标记。
  • unk_token (str, 可选, 默认为 "<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID,而是设置为此标记。
  • pad_token (str, 可选, 默认为 "<pad>") — 用于填充的标记,例如对不同长度的序列进行批处理时。
  • mask_token (str, 可选, 默认为 "<mask>") — 用于屏蔽值的标记。这是在使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入中添加前缀空格。这允许将第一个单词像其他任何单词一样对待。(BART 标记器通过前导空格检测单词的开头)。

构建一个 BART 标记器,它类似于 ROBERTa 标记器,使用字节级字节对编码。

此标记器经过训练,将空格视为标记的一部分(有点像句子片段),因此一个单词将

无论它是否位于句首(没有空格),编码方式都不同。

>>> from transformers import BartTokenizer

>>> tokenizer = BartTokenizer.from_pretrained("facebook/bart-base")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]

>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]

您可以在实例化此分词器或在某些文本上调用它时传递 add_prefix_space=True 来解决此行为,但由于模型不是以这种方式预训练的,因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时,此分词器将在每个词(即使是第一个词)之前添加空格。

此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (List[int]) — 将添加特殊标记的 ID 列表。
  • token_ids_1 (List[int], optional) — 用于序列对的可选第二个 ID 列表。

返回

List[int]

带有适当特殊标记的 输入 ID 列表。

通过连接和添加特殊标记,从序列或一对序列构建用于序列分类任务的模型输入。BART 序列具有以下格式

  • 单个序列: <s> X </s>
  • 序列对: <s> A </s></s> B </s>

convert_tokens_to_string

< >

( tokens )

将一系列标记(字符串)转换为单个字符串。

create_token_type_ids_from_sequences

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], optional) — 用于序列对的可选第二个 ID 列表。

返回

List[int]

零的列表。

从传递的两个序列中创建一个掩码,用于序列对分类任务。BART 不使用标记类型 ID,因此返回一个零列表。

get_special_tokens_mask

< >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], optional) — 用于序列对的可选第二个 ID 列表。
  • already_has_special_tokens (bool, optional, defaults to False) — 令牌列表是否已经使用模型的特殊令牌格式化。

返回

List[int]

一个介于 [0, 1] 之间的整数列表:特殊令牌为 1,序列令牌为 0。

从没有添加特殊令牌的令牌列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊令牌时,会调用此方法。

BartTokenizerFast

class transformers.BartTokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False trim_offsets = True **kwargs )

参数

  • vocab_file (str) — 词汇文件路径。
  • merges_file (str) — 合并文件路径。
  • errors (str, optional, defaults to "replace") — 将字节解码为 UTF-8 时遵循的范例。有关更多信息,请参阅 bytes.decode
  • bos_token (str, optional, defaults to "<s>") — 预训练期间使用的序列开始令牌。可以用作序列分类令牌。

    构建使用特殊令牌的序列时,这不是用于序列开始的令牌。使用的令牌是 cls_token

  • eos_token (str, optional, defaults to "</s>") — 序列结束符。

    使用特殊符号构建序列时,这不是用于序列结束的符号。使用的符号是 sep_token

  • sep_token (str, optional, defaults to "</s>") — 分隔符,用于从多个序列构建序列时,例如两个用于序列分类的序列或用于问答的文本和问题。它也用作使用特殊符号构建的序列的最后一个符号。
  • cls_token (str, optional, defaults to "<s>") — 分类器符号,用于执行序列分类(对整个序列进行分类,而不是对每个符号进行分类)。当使用特殊符号构建时,它是序列的第一个符号。
  • unk_token (str, optional, defaults to "<unk>") — 未知符号。词汇表中没有的符号无法转换为 ID,而是设置为此符号。
  • pad_token (str, optional, defaults to "<pad>") — 用于填充的符号,例如当对不同长度的序列进行批处理时。
  • mask_token (str, optional, defaults to "<mask>") — 用于掩盖值的符号。这是使用掩码语言建模训练此模型时使用的符号。这是模型将尝试预测的符号。
  • add_prefix_space (bool, optional, defaults to False) — 是否在输入中添加前缀空格。这允许将前导词与任何其他词一样对待。(BART 标记器通过前面的空格来检测词的开头)。
  • trim_offsets (bool, optional, defaults to True) — 后处理步骤是否应修剪偏移量以避免包含空格。

构造一个“快速” BART 标记器(由 HuggingFace 的 tokenizers 库支持),源自 GPT-2 标记器,使用字节级字节对编码。

此标记器经过训练,将空格视为标记的一部分(有点像句子片段),因此一个单词将

无论它是否位于句首(没有空格),编码方式都不同。

>>> from transformers import BartTokenizerFast

>>> tokenizer = BartTokenizerFast.from_pretrained("facebook/bart-base")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]

>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]

您可以在实例化此分词器或在某些文本上调用它时传递 add_prefix_space=True 来解决此行为,但由于模型不是以这种方式预训练的,因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时,此标记器需要使用 add_prefix_space=True 初始化。

此标记器继承自 PreTrainedTokenizerFast,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

create_token_type_ids_from_sequences

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可选) — 序列对的第二个 ID 列表(可选)。

返回

List[int]

零的列表。

从传递的两个序列中创建一个掩码,用于序列对分类任务。BART 不使用标记类型 ID,因此返回一个零列表。

Pytorch
隐藏 Pytorch 内容

BartModel

class transformers.BartModel

< >

( config: BartConfig )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。

不带任何特定头的基本 BART 模型,输出原始隐藏状态。该模型继承自 PreTrainedModel。查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.Seq2SeqModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示未掩码的标记,
    • 0 表示已掩码的标记。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列令牌在词汇表中的索引。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成器起始令牌。如果使用 past_key_values,则可选地仅需要输入最后的 decoder_input_ids(请参阅 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,则模型将通过将 input_ids 向右移动来创建此张量,以便根据论文进行去噪预训练。

  • decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充令牌。因果掩码也将默认使用。

    如果您想更改填充行为,您应该阅读 modeling_bart._prepare_decoder_attention_mask 并根据您的需要修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中交叉注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出处的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于(请参阅 past_key_values 输入)加速顺序解码。

    如果使用 past_key_values,则用户可以选择仅输入最后一个 decoder_input_ids(那些没有提供其过去键值状态的模型)的形状为 (batch_size, 1),而不是所有 decoder_input_ids 的形状为 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想对如何将 input_ids 索引转换为相关向量(而不是模型的内部嵌入查找矩阵)有更多控制,这将很有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size)可选) — 可选地,您无需传递 decoder_input_ids 而是选择直接传递嵌入表示。如果使用 past_key_values,则可选地仅需输入最后一个 decoder_inputs_embeds(参见 past_key_values)。如果您希望对如何将 decoder_input_ids 索引转换为关联向量进行更多控制,而不是模型的内部嵌入查找矩阵,这将很有用。

    如果 decoder_input_idsdecoder_inputs_embeds 都未设置,decoder_inputs_embeds 将取 inputs_embeds 的值。

  • use_cache (bool可选) — 如果设置为 True,则会返回 past_key_values 键值状态,并可用于加快解码速度(参见 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.Seq2SeqModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (BartConfig) 和输入的各种元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层的输出处的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    解码器在每个层的输出处的隐藏状态,以及可选的初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 模型编码器最后一层的输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    编码器在每个层的输出处的隐藏状态,以及可选的初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

BartModel 前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, BartModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = BartModel.from_pretrained("facebook/bart-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

BartForConditionalGeneration

class transformers.BartForConditionalGeneration

< >

( config: BartConfig )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。

带语言建模头的 BART 模型。可用于摘要。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、剪枝头等)。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.Seq2SeqLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下将忽略填充。

    索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以获取详细信息。

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length)可选) — 词汇表中解码器输入序列标记的索引。

    索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以获取详细信息。

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始标记。如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(参见 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,则模型将通过将 input_ids 向右移动来创建此张量,以按照论文进行去噪预训练。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果没有提供 decoder_input_ids,模型将通过将 input_ids 右移来创建此张量,以便按照论文进行去噪预训练。

  • decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个忽略 decoder_input_ids 中填充标记的张量。因果掩码也将默认使用。

    如果您想更改填充行为,您应该阅读 modeling_bart._prepare_decoder_attention_mask 并修改以满足您的需求。有关默认策略的更多信息,请参阅 论文 中的图 1。

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads)可选) — 用于使编码器中注意力模块的选定头部无效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使解码器中交叉注意力模块的选定头部无效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor)可选) — 元组包含 (last_hidden_state可选: hidden_states可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size)可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传入 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(tuple(torch.FloatTensor)) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以用来(参见 past_key_values 输入)加速顺序解码。

    如果使用 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(那些没有为这个模型提供过去键值状态的 decoder_input_ids),形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,而不是传递 input_ids,可以选择直接传递嵌入表示。如果您想要比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多控制权,这将很有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size)可选) — 可选地,而不是传递 decoder_input_ids,可以选择直接传递嵌入表示。如果使用 past_key_values,可以选择仅输入最后一个 decoder_inputs_embeds(参见 past_key_values)。如果您想要比模型的内部嵌入查找矩阵对如何将 decoder_input_ids 索引转换为关联向量有更多控制权,这将很有用。

    如果 decoder_input_idsdecoder_inputs_embeds 都未设置,decoder_inputs_embeds 将取 inputs_embeds 的值。

  • use_cache (bool可选) — 如果设置为 True,将返回 past_key_values 键值状态,可以用来加速解码(参见 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 中(请参阅 input_ids 文档字符串)。索引设置为 -100 的令牌将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的令牌计算。

返回

transformers.modeling_outputs.Seq2SeqLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqLMOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包括取决于配置 (BartConfig) 和输入的各种元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(在 SoftMax 之前的每个词汇表令牌的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 模型编码器最后一层的输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

The BartForConditionalGeneration forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

摘要示例

>>> from transformers import AutoTokenizer, BartForConditionalGeneration

>>> model = BartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> ARTICLE_TO_SUMMARIZE = (
...     "PG&E stated it scheduled the blackouts in response to forecasts for high winds "
...     "amid dry conditions. The aim is to reduce the risk of wildfires. Nearly 800 thousand customers were "
...     "scheduled to be affected by the shutoffs which were expected to last through at least midday tomorrow."
... )
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="pt")

>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=2, min_length=0, max_length=20)
>>> tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'PG&E scheduled the blackouts in response to forecasts for high winds amid dry conditions'

掩码填充示例

>>> from transformers import AutoTokenizer, BartForConditionalGeneration

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = BartForConditionalGeneration.from_pretrained("facebook/bart-base")

>>> TXT = "My friends are <mask> but they eat too many carbs."
>>> input_ids = tokenizer([TXT], return_tensors="pt")["input_ids"]
>>> logits = model(input_ids).logits

>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero().item()
>>> probs = logits[0, masked_index].softmax(dim=0)
>>> values, predictions = probs.topk(5)

>>> tokenizer.decode(predictions).split()
['not', 'good', 'healthy', 'great', 'very']

BartForSequenceClassification

class transformers.BartForSequenceClassification

< >

( config: BartConfig **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只加载配置。查看 from_pretrained() 方法加载模型权重。

Bart 模型,顶部有一个序列分类/头(在池化输出之上添加一个线性层),例如用于 GLUE 任务。

此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值:

    • 1 表示 未掩码 的标记,
    • 0 表示 掩码 的标记。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成 的起始标记。如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(请参阅 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建此张量,以根据论文进行去噪预训练。

  • decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,该张量会忽略 decoder_input_ids 中的填充标记。默认情况下还会使用因果掩码。

    如果您想更改填充行为,您应该阅读 modeling_bart._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示 未掩码 的头部,
    • 0 表示 掩码 的头部。
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示 未掩码 的头部,
    • 0 表示 掩码 的头部。
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中交叉注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示 未掩码 的头部,
    • 0 表示 掩码 的头部。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组包含 (last_hidden_state, optional: hidden_states, optional: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), optional) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及两个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

    如果使用了 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(那些没有为此模型给出过去键值状态的)形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入式表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为相关向量,这将非常有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入式表示,而不是传递 decoder_input_ids。如果使用了 past_key_values,可以选择仅输入最后一个 decoder_inputs_embeds(参见 past_key_values)。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 decoder_input_ids 索引转换为相关向量,这将非常有用。

    如果 decoder_input_idsdecoder_inputs_embeds 都未设置,decoder_inputs_embeds 将取 inputs_embeds 的值。

  • use_cache (bool, optional) — 如果设置为 True,将返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_outputs.Seq2SeqSequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或一个包含各种元素的 torch.FloatTensor 元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),这些元素取决于配置 (BartConfig) 和输入。

  • loss (torch.FloatTensor 形状为 (1,)可选,在提供 label 时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 模型编码器最后一层的输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

The BartForSequenceClassification 正向方法覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BartForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("valhalla/bart-large-sst2")
>>> model = BartForSequenceClassification.from_pretrained("valhalla/bart-large-sst2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'POSITIVE'

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BartForSequenceClassification.from_pretrained("valhalla/bart-large-sst2", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.0

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BartForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("valhalla/bart-large-sst2")
>>> model = BartForSequenceClassification.from_pretrained("valhalla/bart-large-sst2", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BartForSequenceClassification.from_pretrained(
...     "valhalla/bart-large-sst2", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

BartForQuestionAnswering

class transformers.BartForQuestionAnswering

< >

( config )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

BART 模型,顶部有一个跨度分类头,用于提取式问答任务,例如 SQuAD(隐藏状态输出顶部的线性层,用于计算 span start logitsspan end logits)。

此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。

forward

< >

( input_ids: Tensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None start_positions: Optional = None end_positions: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

    索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 掩码,用于避免对填充标记索引执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示 未屏蔽 的标记,
    • 0 表示 屏蔽 的标记。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length)可选) — 解码器输入序列词元的词汇表索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成过程的起始词元。如果使用 past_key_values,可以选择仅输入最后一个 decoder_input_ids(参见 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,则模型将通过将 input_ids 向右移动来创建此张量,以遵循论文进行去噪预训练。

  • decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充词元。默认情况下也会使用因果掩码。

    如果您想更改填充行为,您应该阅读 modeling_bart._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参见 论文 中的图 1。

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads)可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 掩码以使解码器中交叉注意模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor)可选) — 元组包含 (last_hidden_state可选: hidden_states可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size)可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意。
  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(tuple(torch.FloatTensor)) 元组,每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以用于(参见 past_key_values 输入)加速顺序解码。

    如果使用 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(那些没有提供其过去键值状态的模型)形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联的向量,这将非常有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size), 可选) — 可选地,而不是传递 decoder_input_ids,您可以选择直接传递嵌入式表示。如果使用了 past_key_values,可以选择仅输入最后一个 decoder_inputs_embeds(参见 past_key_values)。如果您想要更细致地控制如何将 decoder_input_ids 索引转换为关联的向量,而不是模型的内部嵌入查找矩阵,这将很有用。

    如果 decoder_input_idsdecoder_inputs_embeds 均未设置,decoder_inputs_embeds 将取 inputs_embeds 的值。

  • use_cache (bool, 可选) — 如果设置为 True,将返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • start_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算标记分类损失的标记跨度开始位置(索引)的标签。位置被限制在序列长度(sequence_length)内。序列之外的位置不会被考虑用于计算损失。
  • end_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算标记分类损失的标记跨度结束位置(索引)的标签。位置被限制在序列长度(sequence_length)内。序列之外的位置不会被考虑用于计算损失。

返回

transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或者 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或者一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含根据配置(BartConfig)和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选,在提供 labels 时返回) — 总跨度提取损失是开始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度开始分数(在 SoftMax 之前)。

  • end_logits (torch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度结束分数(在 SoftMax 之前)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 模型编码器最后一层的输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,以及每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

BartForQuestionAnswering 正向方法重写了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, BartForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("valhalla/bart-large-finetuned-squadv1")
>>> model = BartForQuestionAnswering.from_pretrained("valhalla/bart-large-finetuned-squadv1")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
' nice puppet'

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
0.59

BartForCausalLM

class transformers.BartForCausalLM

< >

( config )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

BART 解码器,顶部带有语言建模头(与输入嵌入绑定权重的线性层)。

此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免对填充标记索引执行注意的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

  • encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)可选) — 用于避免对编码器输入的填充标记索引执行注意的掩码。如果模型配置为解码器,则在交叉注意力中使用此掩码。在 [0, 1] 中选择掩码值:
  • head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使注意力模块的选定头无效的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示头未被屏蔽,
    • 0 表示头被屏蔽。
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使交叉注意力模块的选定头无效的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示头未被屏蔽,
    • 0 表示头被屏蔽。
  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传入use_cache=Trueconfig.use_cache=True时返回) — 长度为config.n_layerstuple(torch.FloatTensor)元组,每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量,以及两个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。这两个附加张量仅在模型用作序列到序列模型中的解码器时需要。

    包含预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见past_key_values输入)加速顺序解码。

    如果使用past_key_values,用户可以选择性地仅输入最后一个decoder_input_ids(那些没有提供给此模型的过去键值状态的输入)形状为(batch_size, 1),而不是所有decoder_input_ids形状为(batch_size, sequence_length)

  • labels (torch.LongTensor 形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应位于[0, ..., config.vocab_size]或 -100 之间(参见input_ids 文档字符串)。索引设置为-100的标记将被忽略(掩码),损失仅针对标签位于[0, ..., config.vocab_size]的标记计算。
  • use_cache (bool, 可选) — 如果设置为True,将返回past_key_values 键值状态,可用于加速解码(参见past_key_values)。

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstorch.FloatTensor 元组(如果传入return_dict=Falseconfig.return_dict=False),包含根据配置(BartConfig)和输入而不同的各种元素。

  • loss (torch.FloatTensor 形状为(1,), 可选, 在提供labels 时返回) — 语言建模损失(用于下一个标记预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(在 SoftMax 之前的每个词汇表令牌的分数)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 在传入output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型具有嵌入层,以及一个用于每层的输出)形状为(batch_size, sequence_length, hidden_size)

    模型在每层输出处的隐藏状态加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 在传入output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个)形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每个层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    交叉注意力 softmax 之后的交叉注意力权重,用于计算交叉注意力头中的加权平均值。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传入use_cache=Trueconfig.use_cache=True 时返回) — 长度为config.n_layerstorch.FloatTensor 元组,每个元组包含自注意力和交叉注意力层的缓存键、值状态(如果模型用于编码器-解码器设置)。仅在config.is_decoder = True 时才相关。

    包含预计算的隐藏状态(注意力块中的键和值),这些状态可用于(参见past_key_values 输入)加速顺序解码。

示例

>>> from transformers import AutoTokenizer, BartForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = BartForCausalLM.from_pretrained("facebook/bart-base", add_cross_attention=False)
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> logits = outputs.logits
>>> expected_shape = [1, inputs.input_ids.shape[-1], model.config.vocab_size]
>>> list(logits.shape) == expected_shape
True
TensorFlow
隐藏 TensorFlow 内容

TFBartModel

class transformers.TFBartModel

< >

( config: BartConfig load_weight_prefix = None *inputs **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

不带任何特定头的原始 BART 模型,输出原始隐藏状态。此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。

此模型也是 keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解所有与一般用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或
  • 将所有输入作为第一个位置参数中的列表、元组或字典。

支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用诸如 model.fit() 之类的方法时,事情应该“正常工作”——只需将你的输入和标签以 model.fit() 支持的任何格式传递!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建你自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量

  • 只有一个张量的 input_ids,没有其他内容:model(input_ids)
  • 一个可变长度的列表,包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,在使用 子类化 创建模型和层时,你不必担心这些,因为你可以像对任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None decoder_input_ids: np.ndarray | tf.Tensor | None = None decoder_attention_mask: np.ndarray | tf.Tensor | None = None decoder_position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None decoder_head_mask: np.ndarray | tf.Tensor | None = None cross_attn_head_mask: np.ndarray | tf.Tensor | None = None encoder_outputs: Optional[Union[Tuple, TFBaseModelOutput]] = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None inputs_embeds: np.ndarray | tf.Tensor | None = None decoder_inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False **kwargs ) transformers.modeling_tf_outputs.TFSeq2SeqModelOutput or tuple(tf.Tensor)

参数

  • input_ids (tf.Tensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码,用于避免在填充标记索引上执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

  • decoder_input_ids (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始标记。如果使用 past_key_values,可以选择仅输入最后一个 decoder_input_ids(参见 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建此张量,以根据论文进行去噪预训练。

  • 解码器注意力掩码 (tf.Tensor 形状为 (batch_size, target_sequence_length), *可选*) — 默认情况下会生成并忽略填充标记。对于大多数用例,不建议设置此参数。
  • 解码器位置 ID (tf.Tensor 形状为 (batch_size, sequence_length), *可选*) — 解码器输入序列中每个标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • 头掩码 (tf.Tensor 形状为 (encoder_layers, encoder_attention_heads), *可选*) — 用于使编码器中注意力模块的选定头部失效的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • 解码器头掩码 (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), *可选*) — 用于使解码器中注意力模块的选定头部失效的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • 交叉注意力头掩码 (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), *可选*) — 用于使交叉注意力模块的选定头部失效的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • 编码器输出 (tf.FloatTensor, *可选*) — 编码器最后一层输出处的隐藏状态。用于解码器的交叉注意力。形状为 (batch_size, sequence_length, hidden_size) 的序列
  • 过去的键值 (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择性地仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(那些没有提供其过去键值状态的),而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids
  • 输入嵌入 (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), *可选*) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • 使用缓存 (bool, *可选*, 默认值为 True) — 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。在训练期间设置为 False,在生成期间设置为 True
  • 输出注意力 (bool, *可选*) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的 attentions。此参数只能在急切模式下使用,
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states。此参数只能在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用,在图模式下,该值始终设置为 True。
  • training (bool, 可选,默认为 False) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。

返回

transformers.modeling_tf_outputs.TFSeq2SeqModelOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或一个 tf.Tensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (BartConfig) 和输入的各种元素。

  • last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (List[tf.Tensor], 可选,在传递了 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预先计算的解码器隐藏状态(注意块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

  • decoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层的隐藏状态序列。

  • encoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

TFBartModel 正向方法,覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, TFBartModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")
>>> model = TFBartModel.from_pretrained("facebook/bart-large")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFBartForConditionalGeneration

class transformers.TFBartForConditionalGeneration

< >

( config load_weight_prefix = None *inputs **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。查看 from_pretrained() 方法以加载模型权重。

带语言建模头的 BART 模型。可用于摘要。该模型继承自 TFPreTrainedModel。查看超类文档,了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、剪枝头等)。

此模型也是 keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解所有与一般用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或
  • 将所有输入作为第一个位置参数中的列表、元组或字典。

支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用诸如 model.fit() 之类的方法时,事情应该“正常工作”——只需将你的输入和标签以 model.fit() 支持的任何格式传递!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建你自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量

  • 只有一个张量的 input_ids,没有其他内容:model(input_ids)
  • 一个可变长度的列表,包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,在使用 子类化 创建模型和层时,你不必担心这些,因为你可以像对任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None decoder_input_ids: np.ndarray | tf.Tensor | None = None decoder_attention_mask: np.ndarray | tf.Tensor | None = None decoder_position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None decoder_head_mask: np.ndarray | tf.Tensor | None = None cross_attn_head_mask: np.ndarray | tf.Tensor | None = None encoder_outputs: Optional[TFBaseModelOutput] = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None inputs_embeds: np.ndarray | tf.Tensor | None = None decoder_inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSeq2SeqLMOutput or tuple(tf.Tensor)

参数

  • input_ids (tf.Tensor 形状为 ({0})) — 词汇表中输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (tf.Tensor 形状为 ({0}), 可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?

  • decoder_input_ids (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成开始标记。如果使用 past_key_values,可以选择只输入最后一个 decoder_input_ids(参见 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids 。如果未提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建该张量,以按照论文进行去噪预训练。

  • decoder_attention_mask (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 将默认生成,并忽略填充标记。不建议在大多数用例中设置此选项。
  • decoder_position_ids (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列每个标记的位置嵌入的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • head_mask (tf.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值:

    • 1 表示头部未掩码
    • 0 表示头部掩码
  • decoder_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未被掩盖
    • 0 表示头部被掩盖
  • cross_attn_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未被掩盖
    • 0 表示头部被掩盖
  • encoder_outputs (tf.FloatTensor可选) — 编码器最后一层输出处的隐藏状态。用于解码器的交叉注意力。形状为 (batch_size, sequence_length, hidden_size) 是一个序列的
  • past_key_values (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(其过去键值状态未提供给此模型)形状为 (batch_size, 1),而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)
  • inputs_embeds (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入式表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为相关向量有更多控制权,而不是模型的内部嵌入查找矩阵,这将很有用。
  • use_cache (bool可选,默认值为 True) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(请参阅 past_key_values)。在训练期间设置为 False,在生成期间设置为 True
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions。此参数仅可在急切模式下使用,在图形模式下,将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数仅可在急切模式下使用,在图形模式下,将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图形模式下,该值将始终设置为 True。
  • training (bool可选,默认值为 False) — 是否以
  • labels (tf.Tensor 形状为 (batch_size, sequence_length)可选) — 用于计算掩码语言建模损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。

返回

transformers.modeling_tf_outputs.TFSeq2SeqLMOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSeq2SeqLMOutputtf.Tensor 的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含根据配置 (BartConfig) 和输入的不同元素。

  • loss (tf.Tensor 形状为 (n,)可选,当提供 labels 时返回) — 语言建模损失。

  • logits (tf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(在 SoftMax 之前,每个词汇标记的分数)。

  • past_key_values (List[tf.Tensor], 可选,在传递了 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预先计算的解码器隐藏状态(注意块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

  • decoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层的隐藏状态序列。

  • encoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

The TFBartForConditionalGeneration forward method, overrides the __call__ special method.

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

摘要示例

>>> from transformers import AutoTokenizer, TFBartForConditionalGeneration

>>> model = TFBartForConditionalGeneration.from_pretrained("facebook/bart-large")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")

>>> ARTICLE_TO_SUMMARIZE = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="tf")

>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=4, max_length=5)
>>> print(tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False))

掩码填充示例

>>> from transformers import AutoTokenizer, TFBartForConditionalGeneration

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")
>>> TXT = "My friends are <mask> but they eat too many carbs."

>>> model = TFBartForConditionalGeneration.from_pretrained("facebook/bart-large")
>>> input_ids = tokenizer([TXT], return_tensors="tf")["input_ids"]
>>> logits = model(input_ids).logits
>>> probs = tf.nn.softmax(logits[0])
>>> # probs[5] is associated with the mask token

TFBartForSequenceClassification

class transformers.TFBartForSequenceClassification

< >

( config: BartConfig load_weight_prefix = None *inputs **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

Bart 模型,顶部有一个序列分类/头(在池化输出之上添加一个线性层),例如用于 GLUE 任务。

此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、裁剪头部等)。

此模型也是 keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解所有与一般用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或
  • 将所有输入作为第一个位置参数中的列表、元组或字典。

支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用诸如 model.fit() 之类的方法时,事情应该“正常工作”——只需将你的输入和标签以 model.fit() 支持的任何格式传递!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建你自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量

  • 只有一个张量的 input_ids,没有其他内容:model(input_ids)
  • 一个可变长度的列表,包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,在使用 子类化 创建模型和层时,你不必担心这些,因为你可以像对任何其他 Python 函数一样传递输入!

call

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None decoder_input_ids: np.ndarray | tf.Tensor | None = None decoder_attention_mask: np.ndarray | tf.Tensor | None = None decoder_position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None decoder_head_mask: np.ndarray | tf.Tensor | None = None cross_attn_head_mask: np.ndarray | tf.Tensor | None = None encoder_outputs: Optional[TFBaseModelOutput] = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None inputs_embeds: np.ndarray | tf.Tensor | None = None decoder_inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSeq2SeqSequenceClassifierOutputtuple(tf.Tensor)

参数

  • input_ids (tf.Tensor 形状为 ({0})) — 词汇表中输入序列标记的索引。

    索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (tf.Tensor 形状为 ({0}), 可选) — 用于避免对填充标记索引进行注意力的掩码。掩码值选择在 [0, 1] 中:

    • 1 用于未屏蔽的标记,
    • 0 用于屏蔽的标记。

    什么是注意力掩码?

  • decoder_input_ids (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列标记在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成起始标记。如果使用 past_key_values,可以选择仅输入最后一个 decoder_input_ids(见 past_key_values)。

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,则模型将通过将 input_ids 向右移动来创建此张量,以便根据论文进行去噪预训练。

  • decoder_attention_mask (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 将默认创建,并忽略填充标记。对于大多数用例,不建议设置此项。
  • decoder_position_ids (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列标记在位置嵌入中的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。
  • head_mask (tf.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 用于使编码器中注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未屏蔽
    • 0 表示头部屏蔽
  • decoder_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未屏蔽
    • 0 表示头部屏蔽
  • cross_attn_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未屏蔽
    • 0 表示头部屏蔽
  • encoder_outputs (tf.FloatTensor, 可选) — 编码器最后一层输出处的隐藏状态。用于解码器的交叉注意力。形状为 (batch_size, sequence_length, hidden_size) 的一个序列
  • past_key_values (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(这些没有提供给此模型的过去键值状态),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids
  • inputs_embeds (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想要对如何将 input_ids 索引转换为关联向量有更多控制权,而不是模型的内部嵌入查找矩阵,这将很有用。
  • use_cache (bool可选,默认值为 True) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(请参阅 past_key_values)。在训练期间设置为 False,在生成期间设置为 True
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可在急切模式下使用,在图模式下,该值将始终设置为 True。
  • training (bool可选,默认值为 False) — 是否在训练模式下使用模型(某些模块,例如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor 形状为 (batch_size, sequence_length)可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSeq2SeqSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSeq2SeqSequenceClassifierOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置的各种元素(BartConfig)和输入。

  • loss (tf.Tensor 形状为 (1,)可选,在提供 label 时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。

  • logits (tf.Tensor 形状为 (batch_size, config.num_labels)) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。

  • past_key_values (List[tf.Tensor], 可选,在传递了 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预先计算的解码器隐藏状态(注意块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

  • decoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(tf.Tensor)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

  • encoder_last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层的隐藏状态序列。

  • encoder_hidden_states (tuple(tf.Tensor), 可选,在传递了 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(tf.Tensor), 可选,在传递了 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

TFBartForSequenceClassification 正向方法,覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

JAX
隐藏 JAX 内容

FlaxBartModel

class transformers.FlaxBartModel

< >

( config: BartConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认值为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

    这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定,所有计算将使用给定的 dtype 执行。

    请注意,这仅指定计算的 dtype,不会影响模型参数的 dtype。

    如果您希望更改模型参数的 dtype,请参阅 to_fp16()to_bf16()

Bart 模型的裸 Transformer,输出原始隐藏状态,没有顶部特定的头。此模型继承自 FlaxPreTrainedModel。查看超类文档以了解该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块,并参考 Flax 文档以了解与一般使用和行为相关的所有事项。

最后,此模型支持固有的 JAX 功能,例如

__call__

< >

( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,则默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示 **未屏蔽** 的标记,
    • 0 表示 **屏蔽** 的标记。

    什么是注意力掩码?

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,模型将通过将 input_ids 向右移动以遵循论文进行去噪预训练来创建此张量。

    例如,如果 input_ids[1, 2, 3, 4, 5],则 decoder_input_ids 将为 [2, 3, 4, 5, 0]

    使用 PreTrainedTokenizer.prepare_decoder_input_ids_from_labels() 函数准备解码器输入 ID,以确保解码器输入 ID 正确生成。

  • decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充标记。因果掩码也会默认使用。

    如果你想改变填充行为,你应该根据你的需要进行修改。关于默认策略的更多信息,请参见 论文 中的图 1。

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个解码器输入序列标记的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回

transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含根据配置 (BartConfig) 和输入的不同元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出处的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(jnp.ndarray) 的元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法,重写了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBartModel

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = FlaxBartModel.from_pretrained("facebook/bart-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

编码

< >

( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 词汇表中输入序列词元的索引。如果您提供填充,默认情况下将忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length)可选) — 掩码以避免对填充词元索引执行注意力。在 [0, 1] 中选择的掩码值:

    • 1 表示未掩码的词元,
    • 0 表示已掩码的词元。

    什么是注意力掩码?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 每个输入序列词元在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(<class 'transformers.models.bart.configuration_bart.BartConfig'>)和输入的不同元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

示例

>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="jax")
>>> encoder_outputs = model.encode(**inputs)

decode

< >

( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length)) — 解码器输入序列标记在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    解码器输入 ID 是什么?

    对于翻译和摘要训练,应该提供 decoder_input_ids。如果没有提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建该张量,以便根据论文进行去噪预训练。

  • encoder_outputs (tuple(tuple(jnp.ndarray)) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意。
  • encoder_attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示 未被掩码 的标记,
    • 0 表示 被掩码 的标记。

    注意力掩码是什么?

  • decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充标记。因果掩码也将默认使用。

    如果要更改填充行为,则应根据需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

  • decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列标记在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1] 内。
  • past_key_values (Dict[str, np.ndarray], 可选,由 init_cache 返回或在传递之前的 past_key_values 时返回) — 预计算的隐藏状态字典(注意力块中的键和值),可用于快速自动回归解码。预计算的键和值隐藏状态的形状为 [batch_size, max_length]
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(<class 'transformers.models.bart.configuration_bart.BartConfig'>)和输入而不同的各种元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选,在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(jnp.ndarray) 元组,每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及可选地如果 config.is_encoder_decoder=True 则还有 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的张量。

    包含预计算的隐藏状态(自注意力块中的键和值,以及可选地如果 config.is_encoder_decoder=True 则在交叉注意力块中的键和值),可用于加速顺序解码。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.add_cross_attention=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length,

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

示例

>>> import jax.numpy as jnp
>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="jax")
>>> encoder_outputs = model.encode(**inputs)

>>> decoder_start_token_id = model.config.decoder_start_token_id
>>> decoder_input_ids = jnp.ones((inputs.input_ids.shape[0], 1), dtype="i4") * decoder_start_token_id

>>> outputs = model.decode(decoder_input_ids, encoder_outputs)
>>> last_decoder_hidden_states = outputs.last_hidden_state

FlaxBartForConditionalGeneration

class transformers.FlaxBartForConditionalGeneration

< >

( config: BartConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。 请查看 from_pretrained() 方法来加载模型权重。
  • dtype (jax.numpy.dtype, 可选,默认值为 jax.numpy.float32) — 计算的数据类型。 可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

    这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。 如果指定,所有计算都将使用给定的 dtype 执行。

    注意,这仅指定计算的 dtype,不会影响模型参数的 dtype。

    如果希望更改模型参数的 dtype,请参见 to_fp16()to_bf16()

具有语言建模头的 BART 模型。 可用于文本摘要。 此模型继承自 FlaxPreTrainedModel。 查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头部等)。

此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块,并参考 Flax 文档以了解与一般使用和行为相关的所有事项。

最后,此模型支持固有的 JAX 功能,例如

__call__

< >

( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。 如果你提供填充,默认情况下将忽略填充。

    索引可以使用 AutoTokenizer 获取。 有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length)可选) — 掩码,避免对填充标记索引执行注意力。 掩码值在 [0, 1] 中选择:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length)可选) — 解码器输入序列令牌在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建此张量,以进行去噪预训练,遵循论文。

  • decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个忽略 decoder_input_ids 中填充令牌的张量。默认情况下还会使用因果掩码。

    如果您想更改填充行为,则应根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图表 1。

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 每个输入序列令牌在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 每个解码器输入序列令牌在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含取决于配置 (BartConfig) 和输入的各种元素。

  • logits (jnp.ndarray 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇表令牌的分数)。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(jnp.ndarray) 的元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法,重写了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

摘要示例

>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> ARTICLE_TO_SUMMARIZE = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="np")

>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"]).sequences
>>> print(tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False))

掩码填充示例

>>> import jax
>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")

>>> TXT = "My friends are <mask> but they eat too many carbs."
>>> input_ids = tokenizer([TXT], return_tensors="jax")["input_ids"]

>>> logits = model(input_ids).logits
>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero()[0].item()
>>> probs = jax.nn.softmax(logits[0, masked_index], axis=0)
>>> values, predictions = jax.lax.top_k(probs, k=1)

>>> tokenizer.decode(predictions).split()

编码

< >

( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。默认情况下,如果您提供填充,将忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示未屏蔽的标记,
    • 0 表示已屏蔽的标记。

    什么是注意力掩码?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回的张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(<class 'transformers.models.bart.configuration_bart.BartConfig'>)和输入的不同元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

示例

>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="jax")
>>> encoder_outputs = model.encode(**inputs)

decode

< >

( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length)) — 解码器输入序列标记在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    对于翻译和摘要训练,应提供 decoder_input_ids。如果未提供 decoder_input_ids,模型将根据论文通过将 input_ids 向右移动来创建此张量,以进行去噪预训练。

  • encoder_outputs (tuple(tuple(jnp.ndarray)) — 元组由 (last_hidden_state, 可选: hidden_states, 可选: attentions) 组成 last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • encoder_attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示未屏蔽的标记,
    • 0 表示已屏蔽的标记。

    什么是注意力掩码?

  • decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充标记。因果掩码也将默认使用。

    如果您想更改填充行为,您应该根据您的需要进行修改。有关默认策略的更多信息,请参阅论文中的图 1。

  • decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 每个解码器输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.max_position_embeddings - 1]
  • past_key_values (Dict[str, np.ndarray], 可选, 由 init_cache 返回或在传递之前的 past_key_values 时返回) — 预先计算的隐藏状态字典(注意力块中的键和值),可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput,而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一个transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (<class 'transformers.models.bart.configuration_bart.BartConfig'>) 和输入的不同元素。

  • logits (jnp.ndarray 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇表令牌的分数)。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    交叉注意力 softmax 之后的交叉注意力权重,用于计算交叉注意力头中的加权平均值。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layersjnp.ndarray 元组的元组,每个元组包含自注意和交叉注意层的缓存键、值状态(如果模型在编码器-解码器设置中使用)。仅当 config.is_decoder = True 时才相关。

    包含预计算的隐藏状态(注意力块中的键和值),这些状态可用于(参见past_key_values 输入)加速顺序解码。

示例

>>> import jax.numpy as jnp
>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="jax")
>>> encoder_outputs = model.encode(**inputs)

>>> decoder_start_token_id = model.config.decoder_start_token_id
>>> decoder_input_ids = jnp.ones((inputs.input_ids.shape[0], 1), dtype="i4") * decoder_start_token_id

>>> outputs = model.decode(decoder_input_ids, encoder_outputs)
>>> logits = outputs.logits

FlaxBartForSequenceClassification

class transformers.FlaxBartForSequenceClassification

< >

( config: BartConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

  • config (BartConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选,默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

    这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 执行。

    注意,这仅指定计算的 dtype,不会影响模型参数的 dtype。

    如果要更改模型参数的 dtype,请参见 to_fp16()to_bf16()

Bart 模型,顶部有一个序列分类/头(在池化输出之上添加一个线性层),例如用于 GLUE 任务。

该模型继承自 FlaxPreTrainedModel。查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、剪枝头等)。

此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块,并参考 Flax 文档以了解与一般使用和行为相关的所有事项。

最后,此模型支持固有的 JAX 功能,例如

__call__

< >

( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

    索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解更多详细信息。

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 掩码以避免在填充标记索引上执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示未被掩码的标记
    • 0 表示被掩码的标记

    什么是注意力掩码?

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

    索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解更多详细信息。

    什么是解码器输入 ID?

    对于翻译和摘要训练,应提供 decoder_input_ids。如果没有提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建此张量,以根据论文进行去噪预训练。

  • decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个张量,忽略 decoder_input_ids 中的填充标记。因果掩码也将默认使用。

    如果要更改填充行为,则应根据需要进行修改。有关默认策略的更多信息,请参见 论文 中的图 1。

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选定范围为 [0, config.max_position_embeddings - 1].
  • decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个解码器输入序列标记的位置索引。选定范围为 [0, config.max_position_embeddings - 1].
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions.
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states.
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回

transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (BartConfig) 和输入。

  • logits (jnp.ndarray 形状为 (batch_size, config.num_labels)) — 分类(如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(jnp.ndarray) 的元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(参见 past_key_values 输入)加快顺序解码速度。

  • decoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    解码器在每一层输出的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • encoder_hidden_states (tuple(jnp.ndarray), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法,重写了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是此函数,因为前者负责运行前处理和后处理步骤,而后者则静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBartForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = FlaxBartForSequenceClassification.from_pretrained("facebook/bart-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")

>>> outputs = model(**inputs)
>>> logits = outputs.logits

编码

< >

( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (jnp.ndarray 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示 **未掩码** 的标记。
    • 0 表示 **已掩码** 的标记。

    什么是注意力掩码?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选定范围为 [0, config.max_position_embeddings - 1].
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(<class 'transformers.models.bart.configuration_bart.BartConfig'>)和输入的不同元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

示例

>>> from transformers import AutoTokenizer, FlaxBartForConditionalGeneration

>>> model = FlaxBartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")

>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="jax")
>>> encoder_outputs = model.encode(**inputs)

decode

< >

( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length)) — 词汇表中解码器输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是解码器输入 ID?

    对于翻译和摘要训练,应提供 decoder_input_ids。如果没有提供 decoder_input_ids,模型将通过将 input_ids 向右移动来创建此张量,以遵循论文对去噪预训练进行预训练。

  • encoder_outputs (tuple(tuple(jnp.ndarray)) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出处的隐藏状态序列。在解码器的交叉注意力中使用。
  • encoder_attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值选择在 [0, 1] 中:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?