Hugging Face's logo

Transformers 文档

BART

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

BART

PyTorch TensorFlow Flax FlashAttention SDPA

概述

Bart 模型在 BART: Denoising Sequence-to-Sequence Pre-training for Natural Language Generation, Translation, and Comprehension 中被提出，作者是 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 的性能相匹配，在一系列抽象对话、问题解答和摘要任务中取得了新的最先进的结果，增益高达 6 ROUGE。

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

使用技巧：

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

  • 带有编码器和解码器的序列到序列模型。编码器被馈送令牌的损坏版本，解码器被馈送原始令牌（但有一个掩码来隐藏未来的单词，就像常规的 transformers 解码器一样）。以下转换的组合应用于编码器的预训练任务

    • 掩盖随机令牌（类似 BERT）
    • 删除随机令牌
    • 用单个掩码令牌掩盖 k 个令牌的跨度（0 个令牌的跨度是插入掩码令牌）
    • 置换句子
    • 旋转文档使其从特定令牌开始

实现说明

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

Mask 填充

facebook/bart-base 和 facebook/bart-large 检查点可用于填充多 token mask。

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。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！理想情况下，该资源应展示一些新的内容，而不是重复现有资源。

摘要
Fill-Mask （掩码填充）
翻译

另请参阅

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 模型的词汇表大小。定义了在调用 BartModel 或 TFBartModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
  • d_model (int, 可选, 默认为 1024) — 层和 pooler 层的维度。
  • encoder_layers (int, 可选, 默认为 12) — 编码器层数。
  • decoder_layers (int, 可选, 默认为 12) — 解码器层数。
  • encoder_attention_heads (int, 可选, 默认为 16) — Transformer 编码器中每个 attention 层的 attention head 数量。
  • decoder_attention_heads (int, 可选, 默认为 16) — Transformer 解码器中每个 attention 层的 attention head 数量。
  • decoder_ffn_dim (int, 可选, 默认为 4096) — 解码器中 “intermediate”（通常称为 feed-forward）层的维度。
  • encoder_ffn_dim (int, 可选, 默认为 4096) — 编码器中 “intermediate”（通常称为 feed-forward）层的维度。
  • activation_function (str 或 function, 可选, 默认为 "gelu") — 编码器和 pooler 中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
  • dropout (float, 可选, 默认为 0.1) — embeddings、编码器和 pooler 中所有全连接层的 dropout 概率。
  • attention_dropout (float, 可选, 默认为 0.0) — attention 概率的 dropout 比率。
  • activation_dropout (float, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。
  • classifier_dropout (float, 可选, 默认为 0.0) — classifier 的 dropout 比率。
  • max_position_embeddings (int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
  • init_std (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • encoder_layerdrop (float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。
  • decoder_layerdrop (float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。 有关更多详细信息，请参阅 [LayerDrop 论文](see 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 时，强制作为最后一个生成的 token 的 token 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) — merges 文件的路径。
  • errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时要遵循的范例。 有关更多信息，请参阅 bytes.decode。
  • bos_token (str, 可选, 默认为 "<s>") — 预训练期间使用的序列开始 token。 可以用作序列分类器 token。

    当使用特殊 token 构建序列时，这不是用于序列开始的 token。 使用的 token 是 cls_token。
  • eos_token (str, 可选, 默认为 "</s>") — 序列结束 token。

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

构建 BART tokenizer，它类似于 ROBERTa tokenizer，使用字节级 Byte-Pair-Encoding。

此 tokenizer 经过训练，可将空格视为 token 的一部分（有点像 sentencepiece），因此一个单词将

在句子开头（没有空格）还是不在句子开头，其编码会有所不同

>>> 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]

您可以通过在实例化此 tokenizer 或在某些文本上调用它时传递 add_prefix_space=True 来解决此行为，但由于模型并非以这种方式进行预训练，因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此 tokenizer 将在每个单词（甚至是第一个单词）之前添加一个空格。

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

build_inputs_with_special_tokens

< >

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

参数

  • token_ids_0 (List[int]) — 将向其添加特殊 token 的 ID 列表。
  • token_ids_1 (List[int], 可选) — 序列对的可选的第二个 ID 列表。

返回

List[int]

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

通过连接并添加特殊 token，从序列或序列对构建模型输入，以用于序列分类任务。 BART 序列具有以下格式

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

convert_tokens_to_string

< >

( tokens )

将 token 序列（字符串）转换为单个字符串。

create_token_type_ids_from_sequences

< >

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

参数

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

返回

List[int]

零列表。

创建一个来自传递的两个序列的掩码，用于序列对分类任务。BART 不使用 token type id，因此返回一个零列表。

get_special_tokens_mask

< >

( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = 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) — （可选，默认为 False）指示 token 列表是否已使用模型的特殊 token 格式化。

返回

List[int]

一个整数列表，范围为 [0, 1]：1 表示特殊 token，0 表示序列 token。

从没有添加特殊 token 的 token 列表中检索序列 ID。当使用 tokenizer prepare_for_model 方法添加特殊 token 时，将调用此方法。

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) — merges 文件的路径。
  • errors (str, optional, defaults to "replace") — （可选，默认为 "replace"）将字节解码为 UTF-8 时要遵循的范例。有关更多信息，请参阅 bytes.decode。
  • bos_token (str, optional, defaults to "<s>") — （可选，默认为 "<s>"）在预训练期间使用的序列开始 token。可以用作序列分类器 token。

    当使用特殊 token 构建序列时，这不是用于序列开始的 token。使用的 token 是 cls_token。
  • eos_token (str, optional, defaults to "</s>") — （可选，默认为 "</s>"）序列结束 token。

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

构建一个“快速” BART tokenizer（由 HuggingFace 的 tokenizers 库支持），它源自 GPT-2 tokenizer，使用字节级 Byte-Pair-Encoding。

此 tokenizer 经过训练，可将空格视为 token 的一部分（有点像 sentencepiece），因此一个单词将

在句子开头（没有空格）还是不在句子开头，其编码会有所不同

>>> 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]

您可以通过在实例化此 tokenizer 或在某些文本上调用它时传递 add_prefix_space=True 来解决此行为，但由于模型并非以这种方式进行预训练，因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此 tokenizer 需要使用 add_prefix_space=True 实例化。

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回

List[int]

零列表。

创建一个来自传递的两个序列的掩码，用于序列对分类任务。BART 不使用 token type id，因此返回一个零列表。

Pytorch
隐藏 Pytorch 内容

BartModel

class transformers.BartModel

< >

( config: BartConfig )

参数

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

裸 BART 模型输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

< >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.List[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — Mask，用于避免在 padding token 索引上执行 attention。 Mask 值在 [0, 1] 中选择：

    • 1 表示 tokens 未被 mask，
    • 0 表示 tokens 已被 mask。

    什么是 attention masks？

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

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

    什么是 decoder 输入 IDs？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。 如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids（请参阅 past_key_values）。

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

  • decoder_attention_mask (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor, 可选) — 默认行为：生成一个忽略 decoder_input_ids 中的 pad tokens 的张量。 默认情况下，也将使用因果 mask。

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

  • head_mask (形状为 (encoder_layers, encoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify encoder 中 attention 模块的选定 heads。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • decoder_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify decoder 中 attention 模块的选定 heads。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • cross_attn_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify decoder 中 cross-attention 模块的选定 heads。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — Tuple 由 (last_hidden_state, 可选: hidden_states, 可选: attentions) 组成， last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size), 可选) 是 encoder 最后一层的输出处的 hidden-states 序列。 用于 decoder 的 cross-attention 中。
  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

    如果使用 past_key_values，则用户可以选择仅输入最后一个 decoder_input_ids （那些没有将其 past key value states 提供给此模型的）形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。

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

    如果 decoder_input_ids 和 decoder_inputs_embeds 均未设置，则 decoder_inputs_embeds 采用 inputs_embeds 的值。

  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values key value states，并且可以用于加速 decoding（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回的张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。

返回

transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (BartConfig) 和输入。

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor) — 模型 decoder 最后一层的输出处的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    decoder 在每层输出处的 Hidden-states，以及可选的初始 embedding 输出。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    encoder 在每层输出处的 Hidden-states，以及可选的初始 embedding 输出。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

BartModel forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

>>> 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() 方法以加载模型权重。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

< >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.List[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

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

    • 1 表示 token 未被掩盖，
    • 0 表示 token 已被掩盖。

    什么是注意力掩码？

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

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

    什么是解码器输入 IDs？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。 如果使用 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 中的 pad tokens。 默认情况下，也将使用因果掩码。

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

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

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

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

    • 1 表示 head 未被掩盖，
    • 0 表示 head 已被掩盖。
  • 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=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(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_ids 和 decoder_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 的 tokens 将被忽略（掩盖），损失仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

返回

transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)

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

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

  • logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

BartForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

摘要示例

>>> 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 模型，顶部带有序列分类/head（池化输出顶部的线性层），例如用于 GLUE 任务。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

< >

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

参数

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

    可以使用 AutoTokenizer 获取索引。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 IDs？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。Mask 值在 [0, 1] 中选择：

    • 1 表示 token 未被掩盖，
    • 0 表示 token 被掩盖。

    什么是注意力掩码？

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

    可以使用 AutoTokenizer 获取索引。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是解码器输入 IDs？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 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 中的 padding tokens。默认情况下，也会使用因果掩码。

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

  • head_mask (torch.Tensor，形状为 (encoder_layers, encoder_attention_heads)，可选) — 掩码，用于使编码器中 attention 模块的选定 head 失效。Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • decoder_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中 attention 模块的选定 head 失效。Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中 cross-attention 模块的选定 head 失效。Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)，可选) — Tuple 由 (last_hidden_state，可选：hidden_states，可选：attentions) 组成，last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的 hidden-states 序列。在解码器的 cross-attention 中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于加速顺序解码（请参阅 past_key_values 输入）。

    如果使用 past_key_values，用户可以选择仅输入最后一个 decoder_input_ids（那些没有将其过去的 key value 状态提供给此模型的）形状为 (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_ids 和 decoder_inputs_embeds 均未设置，则 decoder_inputs_embeds 采用 inputs_embeds 的值。

  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values key value 状态，并可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。
  • labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。 如果 config.num_labels > 1，则计算分类损失（交叉熵）。

返回

transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或一个 torch.FloatTensor 的 tuple（如果传递 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_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

BartForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

单标签分类示例

>>> 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 模型，顶部带有跨度分类 head，用于抽取式问答任务，如 SQuAD（hidden-states 输出顶部的线性层，用于计算 span start logits 和 span end logits）。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

< >

( input_ids: Tensor = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.List[torch.FloatTensor]] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs?

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — Mask，用于避免在 padding token 索引上执行 attention。 Mask 值在 [0, 1] 中选择：

    • 1 表示 token 未被 mask，
    • 0 表示 token 已被 mask。

    什么是 attention masks?

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

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

    什么是 decoder 输入 IDs?

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。 如果使用了 past_key_values，则可以选择仅输入最后的 decoder_input_ids （请参阅 past_key_values）。

    对于翻译和摘要训练，应提供 decoder_input_ids。 如果未提供 decoder_input_ids，则模型将通过按照论文中的去噪预训练将 input_ids 向右移动来创建此 tensor。

  • decoder_attention_mask (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor, 可选) — 默认行为：生成一个忽略 decoder_input_ids 中的 pad token 的 tensor。 默认情况下，还将使用因果 mask。

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

  • head_mask (形状为 (encoder_layers, encoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify encoder 中 attention 模块的选定 head。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • decoder_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify decoder 中 attention 模块的选定 head。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • cross_attn_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — Mask，用于 nullify decoder 中 cross-attention 模块的选定 head。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — Tuple 由 (last_hidden_state, 可选: hidden_states, 可选: attentions) 组成， last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，可选) 是 encoder 最后一层输出的 hidden-states 序列。 在 decoder 的 cross-attention 中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensor 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensor。

    包含预先计算的 hidden-states（self-attention 块和 cross-attention 块中的 key 和 values），这些 hidden-states 可用于（请参阅 past_key_values 输入）加速顺序解码。

    如果使用了 past_key_values，则用户可以选择仅输入最后的 decoder_input_ids （那些没有将其过去的 key value states 提供给此模型的）形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。

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

    如果 decoder_input_ids 和 decoder_inputs_embeds 均未设置，则 decoder_inputs_embeds 取 inputs_embeds 的值。

  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。
  • start_positions (形状为 (batch_size,) 的 torch.LongTensor, 可选) — 用于计算 token 分类损失的标签跨度的开始位置（索引）的标签。 位置被限制在序列的长度（sequence_length）之内。 序列之外的位置不计入损失计算。
  • end_positions (形状为 (batch_size,) 的 torch.LongTensor, 可选) — 用于计算 token 分类损失的标签跨度的结束位置（索引）的标签。 位置被限制在序列的长度（sequence_length）之内。 序列之外的位置不计入损失计算。

返回

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

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

  • loss (形状为 (1,) 的 torch.FloatTensor, 可选, 当提供 labels 时返回) — 总跨度提取损失是 start 和 end 位置的 Cross-Entropy 的总和。

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

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

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 的 Tuple，其中每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每个层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

BartForQuestionAnswering forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

>>> 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 decoder，顶部带有语言建模 head（线性层，其权重与输入 embeddings 绑定）。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

 < >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

    索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

    什么是 input IDs？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在 [0, 1] 中选择：

    • 1 表示 tokens 未被掩盖，
    • 0 表示 tokens 被掩盖。

    什么是 attention masks？

  • encoder_hidden_states (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出的 hidden-states 序列。如果模型配置为解码器，则在 cross-attention 中使用。
  • encoder_attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在编码器输入的 padding token 索引上执行 attention。如果模型配置为解码器，则此掩码在 cross-attention 中使用。掩码值在 [0, 1] 中选择：
  • head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于 nullify attention 模块的选定 heads。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于 nullify cross-attention 模块的选定 heads。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensors。当模型用作序列到序列模型中的解码器时，才需要这两个附加的 tensors。

    包含预先计算的 hidden-states（self-attention 块和 cross-attention 块中的 key 和 values），可以用于加速顺序解码（参见 past_key_values 输入）。

    如果使用 past_key_values，用户可以选择仅输入最后一次的 decoder_input_ids (那些没有将其 past key value states 提供给此模型的)，形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。

  • labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算 masked language modeling loss 的标签。索引应为 [0, ..., config.vocab_size] 或 -100 (参见 input_ids 文档字符串)。索引设置为 -100 的 tokens 将被忽略（掩盖），loss 仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values key value states，并且可以用于加速解码（参见 past_key_values）。

    • 1 表示 tokens 未被掩盖，
    • 0 表示 tokens 被掩盖。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参见返回的 tensors 下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是一个普通元组。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模 loss (用于 next-token prediction)。

  • logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。

  • hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有 embedding layer，则为 embedding 的输出 + 每层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每层输出端的 Hidden-states，加上可选的初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

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

    Cross attention softmax 之后的 attention weights，用于计算 cross-attention heads 中的加权平均值。

  • past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 元组的元组，每个元组包含 self-attention 和 cross-attention 层的缓存 key, value states（如果模型在 encoder-decoder 设置中使用）。仅在 config.is_decoder = True 时相关。

    包含预先计算的 hidden-states（attention 块中的 key 和 values），可以用于加速顺序解码（参见 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 模型，输出原始 hidden-states，顶部没有任何特定的 head。此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。

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

transformers 中的 TensorFlow 模型和 layers 接受两种输入格式

  • 将所有输入作为关键字参数（如 PyTorch 模型），或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

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

  • 仅包含 input_ids 且不包含其他内容的单个 Tensor：model(input_ids)
  • 包含一个或多个输入 Tensors 的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入 Tensors 的字典，与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 subclassing 创建模型和 layers 时，您无需担心任何这些，因为您可以像对任何其他 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 或 tuple(tf.Tensor)

参数

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

    索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

    什么是 input IDs？

  • attention_mask (tf.Tensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在 [0, 1] 中选择：

    • 1 表示 tokens 未被掩盖，
    • 0 表示 tokens 被掩盖。

    什么是 attention masks？

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

    索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

    什么是解码器输入 ID？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 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)，可选) — 默认情况下将创建，并忽略 pad tokens。 对于大多数用例，不建议设置此项。
  • decoder_position_ids (tf.Tensor，形状为 (batch_size, sequence_length)，可选) — 解码器输入序列中每个 token 的位置索引，用于位置嵌入。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • head_mask (tf.Tensor，形状为 (encoder_layers, encoder_attention_heads)，可选) — 用于置空编码器中注意力模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被屏蔽，
    • 0 表示 head 被屏蔽。
  • decoder_head_mask (tf.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于置空解码器中注意力模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被屏蔽，
    • 0 表示 head 被屏蔽。
  • cross_attn_head_mask (tf.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于置空 cross-attention 模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被屏蔽，
    • 0 表示 head 被屏蔽。
  • encoder_outputs (tf.FloatTensor，可选) — 编码器最后一层的输出的 hidden states。 用于解码器的 cross-attention。 形状为 (batch_size, sequence_length, hidden_size)，是 hidden states 的序列
  • past_key_values (Tuple[Tuple[tf.Tensor]]，长度为 config.n_layers) — 包含注意力模块的预计算的 key 和 value hidden states。 可用于加速解码。 如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（那些没有将其 past key value states 提供给此模型的），形状为 (batch_size, 1)，而不是形状为 (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 key value states，并且可以用于加速解码（请参阅 past_key_values）。 在训练期间设置为 False，在生成期间设置为 True
  • output_attentions (bool，可选) — 是否返回所有注意力层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的 attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。
  • training (bool，可选，默认为 False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。

返回

transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或 tuple(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)) — 模型解码器最后一层输出的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (List[tf.Tensor]，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tf.Tensor 列表，每个 tensor 的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)）。

    包含解码器的预计算 hidden-states（注意力模块中的 key 和 value），可用于加速顺序解码（请参阅 past_key_values 输入）。

  • decoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的 hidden-states 序列。

  • encoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

TFBartModel 前向传播方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

>>> 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。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。

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

transformers 中的 TensorFlow 模型和 layers 接受两种输入格式

  • 将所有输入作为关键字参数（如 PyTorch 模型），或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

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

  • 仅包含 input_ids 且不包含其他内容的单个 Tensor：model(input_ids)
  • 包含一个或多个输入 Tensors 的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入 Tensors 的字典，与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 subclassing 创建模型和 layers 时，您无需担心任何这些，因为您可以像对任何其他 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 或 tuple(tf.Tensor)

参数

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

    索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 IDs？

  • attention_mask (tf.Tensor，形状为 ({0}), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在 [0, 1] 中选择：

    • 1 表示 tokens 未被 Mask，
    • 0 表示 tokens 被 Mask。

    什么是 attention masks？

  • decoder_input_ids (tf.Tensor，形状为 (batch_size, target_sequence_length), 可选) — 词汇表中 decoder 输入序列 tokens 的索引。

    索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是 decoder 输入 IDs？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。 如果使用 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), 可选) — 默认情况下将创建，并忽略 pad tokens。 不建议在大多数用例中设置此项。
  • decoder_position_ids (tf.Tensor，形状为 (batch_size, sequence_length), 可选) — 位置 embeddings 中每个 decoder 输入序列 tokens 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • head_mask (tf.Tensor，形状为 (encoder_layers, encoder_attention_heads), 可选) — 用于使 encoder 中 attention 模块的选定 head 失效的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 Mask，
    • 0 表示 head 被 Mask。
  • decoder_head_mask (tf.Tensor，形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使 decoder 中 attention 模块的选定 head 失效的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 Mask，
    • 0 表示 head 被 Mask。
  • cross_attn_head_mask (tf.Tensor，形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使 cross-attention 模块的选定 head 失效的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 Mask，
    • 0 表示 head 被 Mask。
  • encoder_outputs (tf.FloatTensor, 可选) — encoder 最后一层的输出处的隐藏状态。 在 decoder 的 cross-attention 中使用。 形状为 (batch_size, sequence_length, hidden_size) 的序列是
  • past_key_values (Tuple[Tuple[tf.Tensor]]，长度为 config.n_layers) — 包含 attention 块的预计算的 key 和 value 隐藏状态。 可用于加速解码。 如果使用 past_key_values，则用户可以选择仅输入最后的 decoder_input_ids（那些没有将其 past key value 状态提供给此模型的），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
  • inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • use_cache (bool, 可选, 默认为 True) — 如果设置为 True，则返回 past_key_values key value 状态，并且可以用于加速解码（请参阅 past_key_values）。 训练期间设置为 False，生成期间设置为 True
  • output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回的张量下的 attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的张量下的 hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。
  • training (bool, 可选, 默认为 False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。
  • labels (tf.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于计算 masked language modeling loss 的标签。 索引应为 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）。 索引设置为 -100 的 tokens 将被忽略（masked），loss 仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

返回

transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (BartConfig) 和输入。

  • loss (tf.Tensor，形状为 (n,), 可选, 当提供 labels 时返回，其中 n 是非 masked 标签的数量) — Language modeling loss。

  • logits (tf.Tensor，形状为 (batch_size, sequence_length, config.vocab_size)) — language modeling head 的预测分数（SoftMax 之前的每个词汇表 token 的分数）。

  • past_key_values (List[tf.Tensor]，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tf.Tensor 列表，每个 tensor 的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)）。

    包含解码器的预计算 hidden-states（注意力模块中的 key 和 value），可用于加速顺序解码（请参阅 past_key_values 输入）。

  • decoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的 hidden-states 序列。

  • encoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

TFBartForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

摘要示例

>>> 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 模型，顶部带有序列分类/head（池化输出顶部的线性层），例如用于 GLUE 任务。

此模型继承自 TFPreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、pruning heads 等）

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

transformers 中的 TensorFlow 模型和 layers 接受两种输入格式

  • 将所有输入作为关键字参数（如 PyTorch 模型），或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

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

  • 仅包含 input_ids 且不包含其他内容的单个 Tensor：model(input_ids)
  • 包含一个或多个输入 Tensors 的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入 Tensors 的字典，与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 subclassing 创建模型和 layers 时，您无需担心任何这些，因为您可以像对任何其他 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.TFSeq2SeqSequenceClassifierOutput 或 tuple(tf.Tensor)

参数

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

    索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 IDs？

  • attention_mask (tf.Tensor, 形状为 ({0}), 可选) — 掩码，用于避免在填充 token 索引上执行注意力机制。掩码值在 [0, 1] 中选择：

    • 1 表示 token 未被掩码，
    • 0 表示 token 被掩码。

    什么是注意力掩码？

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

    索引可以使用 AutoTokenizer 获取。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是解码器输入 ID？

    Bart 使用 eos_token_id 作为 decoder_input_ids 生成的起始 token。如果使用了 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), 可选) — 默认情况下将创建，并忽略填充 token。 大多数用例不建议设置此项。
  • decoder_position_ids (tf.Tensor, 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列中每个 token 在位置嵌入中的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • head_mask (tf.Tensor, 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码，用于使编码器中注意力模块的选定 head 失效。 掩码值在 [0, 1] 中选择：

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

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

    • 1 表示 head 未被掩码，
    • 0 表示 head 被掩码。
  • encoder_outputs (tf.FloatTensor, 可选) — 编码器最后一层的输出的隐藏状态。 用于解码器的交叉注意力。 形状为 (batch_size, sequence_length, hidden_size) 的序列是
  • past_key_values (Tuple[Tuple[tf.Tensor]], 长度为 config.n_layers) — 包含注意力模块的预先计算的 key 和 value 隐藏状态。 可用于加速解码。 如果使用了 past_key_values，用户可以选择仅输入最后的 decoder_input_ids （那些没有将其 past key value 状态提供给此模型的），形状为 (batch_size, 1)，而不是所有形状为 (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。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的张量下的 hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 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.TFSeq2SeqSequenceClassifierOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSeq2SeqSequenceClassifierOutput 或 tf.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=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tf.Tensor 列表，每个 tensor 的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)）。

    包含解码器的预计算 hidden-states（注意力模块中的 key 和 value），可用于加速顺序解码（请参阅 past_key_values 输入）。

  • decoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

  • 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)，可选) — 模型编码器最后一层输出的 hidden-states 序列。

  • encoder_hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

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

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

TFBartForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

JAX
隐藏 JAX 内容

FlaxBartModel

class transformers.FlaxBartModel

< >

( config: BartConfig input_shape: typing.Tuple[int] = (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.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

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

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

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

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

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

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

__call__

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

  • attention_mask (jnp.ndarray，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩盖 的 tokens，
    • 0 表示 被掩盖 的 tokens。

    什么是 attention 掩码？

  • decoder_input_ids (jnp.ndarray，形状为 (batch_size, target_sequence_length)，可选) — 词汇表中 decoder 输入序列 tokens 的索引。

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

    什么是 decoder 输入 IDs？

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

  • decoder_attention_mask (jnp.ndarray，形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 padding tokens。因果掩码也将默认使用。

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

  • position_ids (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • decoder_position_ids (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个 decoder 输入序列 tokens 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通的 tuple。

返回

transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含各种元素，具体取决于配置 (BartConfig) 和输入。

  • last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)) — 模型 decoder 最后一层的输出处的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(jnp.ndarray))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(jnp.ndarray)) 的 tuple，其中每个 tuple 具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • decoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • encoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

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

encode

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

  • attention_mask (jnp.ndarray，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩盖 的 tokens，
    • 0 表示 被掩盖 的 tokens。

    什么是 attention 掩码？

  • position_ids (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通的 tuple。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor 的 tuple （如果传递了 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 序列。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

示例

>>> 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: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: dict = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • decoder_input_ids (jnp.ndarray，形状为 (batch_size, target_sequence_length)) — 词汇表中 decoder 输入序列 tokens 的索引。

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

    什么是 decoder 输入 IDs？

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

  • encoder_outputs (tuple(tuple(jnp.ndarray)) — Tuple 由 (last_hidden_state, 可选: hidden_states, 可选: attentions) 组成 last_hidden_state 形状为 (batch_size, sequence_length, hidden_size)，可选) 是 encoder 最后一层输出处的 hidden-states 序列。 在 decoder 的 cross-attention 中使用。
  • encoder_attention_mask (jnp.ndarray，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩盖 的 tokens，
    • 0 表示 被掩盖 的 tokens。

    什么是 attention 掩码？

  • 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.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 torch.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 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(jnp.ndarray))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(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，则在交叉注意力块中），这些状态可用于（请参阅 past_key_values 输入）加速顺序解码。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

示例

>>> 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: typing.Tuple[int] = (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.float32、jax.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: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或 tuple(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.FlaxSeq2SeqLMOutput 或 tuple(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=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(jnp.ndarray)) 的 tuple，其中每个 tuple 具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • decoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • encoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

摘要示例

>>> 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()

encode

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(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.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor 的 tuple （如果传递了 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 序列。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

示例

>>> 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: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: dict = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(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.FlaxCausalLMOutputWithCrossAttentions 或 tuple(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 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    Cross attention softmax 之后的 attention weights，用于计算 cross-attention heads 中的加权平均值。

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

    包含预先计算的 hidden-states（attention 块中的 key 和 values），可以用于加速顺序解码（参见 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: typing.Tuple[int] = (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.float32、jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 之一。

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

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

    如果您希望更改模型参数的 dtype，请参见 to_fp16() 和 to_bf16()。

Bart 模型，顶部带有序列分类/head（池化输出顶部的线性层），例如用于 GLUE 任务。

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

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

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

__call__

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutput 或 tuple(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.FlaxSeq2SeqSequenceClassifierOutput 或 tuple(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=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(jnp.ndarray)) 的 tuple，其中每个 tuple 具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • decoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • encoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

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

encode

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(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.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor 的 tuple （如果传递了 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 序列。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

示例

>>> 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: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: dict = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(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.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 torch.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 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(jnp.ndarray))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(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，则在交叉注意力块中），这些状态可用于（请参阅 past_key_values 输入）加速顺序解码。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

示例

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

FlaxBartForQuestionAnswering

class transformers.FlaxBartForQuestionAnswering

< >

( config: BartConfig input_shape: typing.Tuple[int] = (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.float32, jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 之一。

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

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

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

BART 模型，顶部带有跨度分类 head，用于抽取式问答任务，如 SQuAD（hidden-states 输出顶部的线性层，用于计算 span start logits 和 span end logits）。

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

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

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

__call__

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqQuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

  • attention_mask (jnp.ndarray, 形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩码 的 tokens，
    • 0 表示 被掩码 的 tokens。

    什么是 attention 掩码？

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

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

    什么是解码器输入 IDs？

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

  • decoder_attention_mask (jnp.ndarray, 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 pad tokens。 默认情况下，也将使用因果掩码。

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

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

返回

transformers.modeling_flax_outputs.FlaxSeq2SeqQuestionAnsweringModelOutput or tuple(torch.FloatTensor)

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

  • start_logits (jnp.ndarray, 形状为 (batch_size, sequence_length)) — Span-start 分数（在 SoftMax 之前）。

  • end_logits (jnp.ndarray, 形状为 (batch_size, sequence_length)) — Span-end 分数（在 SoftMax 之前）。

  • past_key_values (tuple(tuple(jnp.ndarray))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(jnp.ndarray)) 的 tuple，其中每个 tuple 具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（自 attention 块和 cross-attention 块中的 key 和 values），可用于（请参阅 past_key_values 输入）加速顺序 decoding。

  • decoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • decoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

  • encoder_last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每一层输出端以及初始嵌入输出端的隐藏状态。

  • encoder_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 Attention 权重，在 attention softmax 之后，用于计算自 attention heads 中的加权平均值。

FlaxBartPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBartForQuestionAnswering

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

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")

>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits

encode

< >

( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

  • attention_mask (jnp.ndarray, 形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩码 的 tokens，
    • 0 表示 被掩码 的 tokens。

    什么是 attention 掩码？

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

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor 的 tuple （如果传递了 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 序列。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

示例

>>> 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: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: dict = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

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

    什么是解码器输入 IDs？

    对于翻译和摘要训练，应提供 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), 可选) 是编码器最后一层输出的 hidden-states 序列。 在解码器的 cross-attention 中使用。
  • encoder_attention_mask (jnp.ndarray of shape (batch_size, sequence_length), optional) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择：

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

    什么是 attention 掩码？

  • decoder_attention_mask (jnp.ndarray of shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 padding 标记。默认情况下，也会使用因果掩码。

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

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

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 torch.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 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(jnp.ndarray))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(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，则在交叉注意力块中），这些状态可用于（请参阅 past_key_values 输入）加速顺序解码。

  • hidden_states (tuple(jnp.ndarray)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

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

    decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。

示例

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

FlaxBartForCausalLM

class transformers.FlaxBartForCausalLM

< >

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

参数

  • config (BartConfig) — 具有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, optional, 默认为 jax.numpy.float32) — 计算的数据类型。 可以是 jax.numpy.float32、jax.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: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None encoder_hidden_states: typing.Optional[jax.Array] = None encoder_attention_mask: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: dict = None past_key_values: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • decoder_input_ids (jnp.ndarray of shape (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, optional: hidden_states, optional: attentions) 组成， last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，optional) 是编码器最后一层输出端的隐藏状态序列。 在解码器的交叉 attention 中使用。
  • encoder_attention_mask (jnp.ndarray of shape (batch_size, sequence_length), optional) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择：

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

    什么是 attention 掩码？

  • decoder_attention_mask (jnp.ndarray of shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 padding 标记。默认情况下，也会使用因果掩码。

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

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

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (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 的 tuple （embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    模型在每一层输出处的 Hidden-states 加上初始 embedding 输出。

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

    attention softmax 之后的 Attention weights，用于计算 self-attention heads 中的加权平均值。

  • cross_attentions (tuple(jnp.ndarray)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的 tuple （每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    Cross attention softmax 之后的 attention weights，用于计算 cross-attention heads 中的加权平均值。

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

    包含预先计算的 hidden-states（attention 块中的 key 和 values），可以用于加速顺序解码（参见 past_key_values 输入）。

FlaxBartDecoderPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的 recipe 需要在此函数中定义，但应在此之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxBartForCausalLM

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

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

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]
< > 在 GitHub 上更新

←Bamba BARThez→