MBart模型在Yinhan Liu、Jiatao Gu、Naman Goyal等人发表的《Multilingual Denoising Pre-training for Neural Machine Translation》（神经网络机器翻译的多语言去噪预训练）中提出。
根据摘要，MBART 是使用 BART 目标在多个语言的规模庞大的单语语料库上预训练的序列到序列去噪自编码器。MBART 是第一个通过去噪多种语言的完整文本来预训练完整序列到序列模型的方法之一，而之前的方法只关注编码器、解码器或文本的一部分重构。
此模型由 valhalla 贡献。作者的代码可以在 这里 找到
MBart 的训练
MBart 是一个主要用于翻译任务的多种语言编码器-解码器（序列到序列）模型。由于该模型是多语言的，它期望序列以不同格式呈现。源文本格式是 X [eos, src_lang_code]，其中 X 是源文本。目标文本格式是 [tgt_lang_code] X [eos]。不使用 bos。
正常的 call() 将对以第一个参数或 text 关键字提供的源文本格式进行编码，并使用 text_label 关键字参数提供的目标文本格式进行编码。
- 监督训练
>>> from transformers import MBartForConditionalGeneration, MBartTokenizer
>>> tokenizer = MBartTokenizer.from_pretrained("facebook/mbart-large-en-ro", src_lang="en_XX", tgt_lang="ro_RO")
>>> example_english_phrase = "UN Chief Says There Is No Military Solution in Syria"
>>> expected_translation_romanian = "Şeful ONU declară că nu există o soluţie militară în Siria"
>>> inputs = tokenizer(example_english_phrase, text_target=expected_translation_romanian, return_tensors="pt")
>>> model = MBartForConditionalGeneration.from_pretrained("facebook/mbart-large-en-ro")
>>> # forward pass
>>> model(**inputs)生成
在生成目标文本集合时，将
decoder_start_token_id设置为目标语言 id。以下示例展示了如何使用 facebook/mbart-large-en-ro 模型将英语翻译成罗马尼亚语。
>>> from transformers import MBartForConditionalGeneration, MBartTokenizer
>>> tokenizer = MBartTokenizer.from_pretrained("facebook/mbart-large-en-ro", src_lang="en_XX")
>>> article = "UN Chief Says There Is No Military Solution in Syria"
>>> inputs = tokenizer(article, return_tensors="pt")
>>> translated_tokens = model.generate(**inputs, decoder_start_token_id=tokenizer.lang_code_to_id["ro_RO"])
>>> tokenizer.batch_decode(translated_tokens, skip_special_tokens=True)[0]
"Şeful ONU declară că nu există o soluţie militară în Siria"MBart-50 概述
MBart-50 由 Yuqing Tang、Chau Tran、Xian Li、Peng-Jen Chen、Naman Goyal、Vishrav Chaudhary、Jiatao Gu 和 Angela Fan 在论文“使用可扩展的多语言预训练和微调进行多语言翻译”中引入。MBart-50 使用原始的 mbart-large-cc25 验证点创建，通过使用随机初始化的向量扩展其嵌入层以获得额外的 25 个语言标记集合，然后在 50 种语言上预训练。
根据摘要
多语言翻译模型可以通过多语言微调来创建。与单方向微调不同，预训练模型同时向许多方向微调。这表明预训练模型可以扩展以纳入更多语言，而不会损失性能。多语言微调相对于最强大的基线（无论是从头开始的多语言还是双语微调）平均增加了1 BLEU，同时在从头开始的 bilingual baselines 上平均增加了9.3 BLEU。
MBart-50 的训练
MBart-50 使用的文本格式与 mBART 略有不同。对于 MBart-50，语言 id token 被用作源文本和目标文本的前缀，即文本格式为 [lang_code] X [eos]，其中 lang_code 是源文本的源语言 ID，是目标文本的目标语言 ID，X 分别是源或目标文本。
MBart-50 有自己的分词器 MBart50Tokenizer。
- 监督训练
from transformers import MBartForConditionalGeneration, MBart50TokenizerFast
model = MBartForConditionalGeneration.from_pretrained("facebook/mbart-large-50")
tokenizer = MBart50TokenizerFast.from_pretrained("facebook/mbart-large-50", src_lang="en_XX", tgt_lang="ro_RO")
src_text = " UN Chief Says There Is No Military Solution in Syria"
tgt_text = "Şeful ONU declară că nu există o soluţie militară în Siria"
model_inputs = tokenizer(src_text, text_target=tgt_text, return_tensors="pt")
model(**model_inputs) # forward pass生成
使用 mBART-50 多语言翻译模型生成文本时，使用
eos_token_id作为decoder_start_token_id，并将目标语言 id 作为第一个生成的 token 强制代入。要将目标语言 id 作为第一个生成的 token 强制代入，请将 forced_bos_token_id 参数传递给 generate 方法。以下示例展示了如何使用 facebook/mbart-50-large-many-to-many 检查点将印地语翻译成法语，将阿拉伯语翻译成英语。
from transformers import MBartForConditionalGeneration, MBart50TokenizerFast
article_hi = "संयुक्त राष्ट्र के प्रमुख का कहना है कि सीरिया में कोई सैन्य समाधान नहीं है"
article_ar = "الأمين العام للأمم المتحدة يقول إنه لا يوجد حل عسكري في سوريا."
model = MBartForConditionalGeneration.from_pretrained("facebook/mbart-large-50-many-to-many-mmt")
tokenizer = MBart50TokenizerFast.from_pretrained("facebook/mbart-large-50-many-to-many-mmt")
# translate Hindi to French
tokenizer.src_lang = "hi_IN"
encoded_hi = tokenizer(article_hi, return_tensors="pt")
generated_tokens = model.generate(**encoded_hi, forced_bos_token_id=tokenizer.lang_code_to_id["fr_XX"])
tokenizer.batch_decode(generated_tokens, skip_special_tokens=True)
# => "Le chef de l 'ONU affirme qu 'il n 'y a pas de solution militaire en Syria."
# translate Arabic to English
tokenizer.src_lang = "ar_AR"
encoded_ar = tokenizer(article_ar, return_tensors="pt")
generated_tokens = model.generate(**encoded_ar, forced_bos_token_id=tokenizer.lang_code_to_id["en_XX"])
tokenizer.batch_decode(generated_tokens, skip_special_tokens=True)
# => "The Secretary-General of the United Nations says there is no military solution in Syria."文档资源
MBartConfig
类 transformers.MBartConfig
< 源代码 >( 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 use_cache =True is_encoder_decoder = True 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 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 forced_eos_token_id = 2 **kwargs )
参数
- vocab_size （
int，可选，默认50265）— MBART模型的词汇量。定义了调用MBartModel或TFMBartModel时传入的inputs_ids可以表示的不同标记的数量。 - d_model （
int，可选，默认1024）— 层和池化层的空间维度。 - encoder_layers （
int，可选，默认12）— 编码器层数。 - decoder_layers （
int，可选，默认12）— 解码器层数。 - encoder_attention_heads (
int, 可选，默认为16) — Transformer编码器中每个注意力层的注意力头部数量。 - decoder_attention_heads (
int, 可选，默认为16) — Transformer解码器中每个注意力层的注意力头部数量。 - decoder_ffn_dim (
int, 可选，默认为4096) — 解码器中“中间”层（常称为前馈层）的维度。 - encoder_ffn_dim (
int, 可选，默认为4096) — 编码器中“中间”层（常称为前馈层）的维度。 - 激活函数 (
str或function，可选，默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。 - dropout (
float，可选，默认为 0.1) — 在嵌入层、编码器和池化器中所有完全连接层的dropout概率。 - attention_dropout (
float，可选，默认为 0.0) — 注意力概率的dropout比率。 - activation_dropout (
float，可选，默认为0.0） — 全连接层内激活函数的dropout比率。 - classifier_dropout (
float，可选，默认为0.0） — 分类器的dropout比率。 - max_position_embeddings (
int，可选，默认为1024） — 模型可能使用的最大序列长度。通常设置一个相对较大的值以防万一（例如，512或1024或2048）。 - init_std (
float，可选，默认为0.02） — 用于初始化所有权重矩阵的truncated_normal_initializer的标准差。 - encoder_layerdrop (
float，可选，默认为0.0) — 编码器的层dropout概率。关于更多详情，请参阅[LayerDrop论文](https://arxiv.org/abs/1909.11556)。 - decoder_layerdrop (
float，可选，默认为0.0) — 解码器的层dropout概率。关于更多详情，请参阅[LayerDrop论文](https://arxiv.org/abs/1909.11556)。 - scale_embedding (
bool，可选，默认为False） — 通过除以sqrt(d_model)来缩放嵌入。 - use_cache (
bool，可选，默认为True） — 模型是否应该返回最后一个键/值注意力（不是所有模型都使用） - forced_eos_token_id (
int, 可选, 默认为2) — 当max_length达到时强制作为最后一个生成的标记的token id。通常设置为eos_token_id。
这是存储MBartModel配置的配置类。它根据指定的参数实例化MBART模型，定义模型架构。使用默认值实例化配置将产生与MBART facebook/mbart-large-cc25 架构相似的配置。
配置对象继承自PretrainedConfig，可用于控制模型输出。更多信息请参阅PretrainedConfig的文档。
示例
>>> from transformers import MBartConfig, MBartModel
>>> # Initializing a MBART facebook/mbart-large-cc25 style configuration
>>> configuration = MBartConfig()
>>> # Initializing a model (with random weights) from the facebook/mbart-large-cc25 style configuration
>>> model = MBartModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMBartTokenizer
class transformers.MBartTokenizer
< source >( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' tokenizer_file = None src_lang = None tgt_lang = None sp_model_kwargs: Optional = None additional_special_tokens = None **kwargs )
构建MBART分词器。
基于RobertaTokenizer和XLNetTokenizer进行适配。基于SentencePiece。
源语言文档的分词方法为<tokens> <eos> <language code>，目标语言文档为`<language code> <tokens> <eos>`。
示例
>>> from transformers import MBartTokenizer
>>> tokenizer = MBartTokenizer.from_pretrained("facebook/mbart-large-en-ro", src_lang="en_XX", tgt_lang="ro_RO")
>>> example_english_phrase = " UN Chief Says There Is No Military Solution in Syria"
>>> expected_translation_romanian = "Şeful ONU declară că nu există o soluţie militară în Siria"
>>> inputs = tokenizer(example_english_phrase, text_target=expected_translation_romanian, return_tensors="pt")build_inputs_with_special_tokens
< source >( token_ids_0: 列表 token_ids_1: 可选 = None ) → 列表[int]
通过连接并添加特殊标记来构建用于序列分类任务的模型输入序列或序列对。MBART序列具有以下格式，其中X表示序列
输入ids(编码器)X [eos, src_lang_code]解码器输入ids: (解码器)X [eos, tgt_lang_code]
BOS never used. The expected use case for pair of sequences is not handled with a separator.
MBartTokenizerFast
类 transformers.MBartTokenizerFast
< source >( vocab_file = None tokenizer_file = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' src_lang = None tgt_lang = None additional_special_tokens = None **kwargs )
构造一个“快速”的MBART标记化器（基于HuggingFace的tokenizers库）。基于BPE。
此标记化器继承自PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此类以获取有关这些方法的更多信息。
源语言文档的分词方法为<tokens> <eos> <language code>，目标语言文档为`<language code> <tokens> <eos>`。
示例
>>> from transformers import MBartTokenizerFast
>>> tokenizer = MBartTokenizerFast.from_pretrained(
... "facebook/mbart-large-en-ro", src_lang="en_XX", tgt_lang="ro_RO"
... )
>>> example_english_phrase = " UN Chief Says There Is No Military Solution in Syria"
>>> expected_translation_romanian = "Şeful ONU declară că nu există o soluţie militară în Siria"
>>> inputs = tokenizer(example_english_phrase, text_target=expected_translation_romanian, return_tensors="pt")build_inputs_with_special_tokens
( token_ids_0: 列表 token_ids_1: 可选 = None ) → 列表[int]
参数
返回值
列表[int]
包含适当特殊标记的输入ID列表。
通过连接并添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。
MBART序列具有以下格式，其中X表示序列
输入ids(编码器)X [eos, src_lang_code]解码器输入ids: (解码器)X [eos, tgt_lang_code]
BOS never used. The expected use case for pair of sequences is not handled with a separator.
创建从序列生成标记类型ID
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 = None ) → 列表[int]
根据传入的两个序列创建一个用于序列对分类任务的掩码。mBART不使用标记类型ID，因此返回一个零列表。
重置特殊标记为源语言设置。没有前缀和后缀=[eos, src_lang_code]。
重置特殊标记为目标语言设置。没有前缀和后缀=[eos, tgt_lang_code]。
MBart50Tokenizer
类 transformers.MBart50Tokenizer
< source >( vocab_file src_lang = None tgt_lang = None eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' sp_model_kwargs: Optional = None **kwargs )
参数
- vocab_file (
str) — 词汇文件路径。 - src_lang (
str, 可选) — 表示源语言的字符串。 - tgt_lang (
str, 可选) — 表示目标语言的字符串。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，在从多个序列构建序列时使用，例如用于序列分类的两个序列或用于问答中的文本和问题，它也被用作用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认为"<s>") — 当进行序列分类（对整个序列进行分类而不是按令牌分类）时使用的分类令牌。当与特殊令牌一起构建时，它是序列的第一个令牌。 - unk_token (
str, 可选, 默认为"<unk>") — 未知令牌。不在词汇表中的令牌无法转换为ID，并设置为该令牌。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的令牌，例如在处理不同长度的序列批处理时。 - mask_token（《字符串`, 可选, 默认为
"<mask>"）——用于遮蔽值的标记。这是在训练此模型进行遮蔽语言模型时使用的标记。这是模型将尝试预测的标记。 - sp_model_kwargs （
字典, 可选）——将被传递给SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 包装器可以用于设置以下内容，例如：-
enable_sampling: 启用子词正则化。 -
nbest_size: 单词采样的参数。在 BPE-Dropout 中无效。nbest_size = {0,1}: 不进行采样。nbest_size > 1: 从 nbest_size 结果中采样。nbest_size < 0: 假设 nbest_size 是无限的，并使用前向滤波-后向采样算法从所有假设（格布）中进行采样。
-
alpha: 单词采样的平滑参数，以及 BPE-dropout 中合并操作的 dropout 概率。
-
构建 MBart50 标记器。基于 SentencePiece。
此标记器从 PreTrainedTokenizer 继承，其中包含大多数主要方法。用户应参考该超类以获取有关这些方法的更多信息。
示例
>>> from transformers import MBart50Tokenizer
>>> tokenizer = MBart50Tokenizer.from_pretrained("facebook/mbart-large-50", src_lang="en_XX", tgt_lang="ro_RO")
>>> src_text = " UN Chief Says There Is No Military Solution in Syria"
>>> tgt_text = "Şeful ONU declară că nu există o soluţie militară în Siria"
>>> model_inputs = tokenizer(src_text, text_target=tgt_text, return_tensors="pt")
>>> # model(**model_inputs) should workbuild_inputs_with_special_tokens
< source >( token_ids_0: 列表 token_ids_1: 可选 = None ) → 列表[int]
通过连接并添加特殊标记来从序列或成对的序列构建模型输入，用于序列分类任务。MBART-50序列的格式如下，其中X表示序列
input_ids(解码器)[src_lang_code] X [eos]labels: (解码器)[tgt_lang_code] X [eos]
BOS never used. The expected use case for pair of sequences is not handled with a separator.
将一系列标记（字符串）转换成单个字符串。
get_special_tokens_mask
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 None already_has_special_tokens: 布尔值 False ) → 列表[int]
从没有添加特殊标记的token列表中检索序列ID。此方法在调用tokenizer的prepare_for_model方法添加特殊标记时调用。
将特殊标记重置为源语言设置。前缀=[src_lang_code]，后缀=[eos]。
将特殊标记重置为目标语言设置。前缀=[tgt_lang_code] 和后缀=[eos]。
MBart50TokenizerFast
类 transformers.MBart50TokenizerFast
< source >( vocab_file = None src_lang = None tgt_lang = None tokenizer_file = None eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' **kwargs )
参数
- vocab_file (
str) — 词汇文件路径。 - src_lang (
str, 可选) — 表示源语言的字符串。 - tgt_lang （
str，可选项） — 表示目标语言的字符串。 - eos_token （
str，可选项，默认为"</s>"） — 序列结束标记。 - sep_token （
str，可选项，默认为"</s>"） — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答问题的文本和问题。它也是使用特殊标记构建的序列中的最后一个标记。 - cls_token（
str，可选，默认为<s>）—当执行序列分类时（整个序列的分类而不是每个标记的分类）使用的分类标记。当与特殊标记构建时，它是序列的第一个标记。 - unk_token（
str，可选，默认为<unk>）—未知标记。不在词汇表中的标记不能转换为ID，因此设置为该标记。 - pad_token（
str，可选，默认为<pad>）—用于填充的标记，例如批处理不同长度的序列时。 - mask_token (
str, 可选, 默认为"<mask>") — 用于遮蔽值的标记。此标记用于使用遮蔽语言建模训练此模型。这是模型将尝试预测的标记。
构建一个快速 MBART tokenizer 用于 mBART-50（由 Hugging Face 的 tokenizers 库支持）。基于 BPE。
此标记化器继承自PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此类以获取有关这些方法的更多信息。
示例
>>> from transformers import MBart50TokenizerFast
>>> tokenizer = MBart50TokenizerFast.from_pretrained("facebook/mbart-large-50", src_lang="en_XX", tgt_lang="ro_RO")
>>> src_text = " UN Chief Says There Is No Military Solution in Syria"
>>> tgt_text = "Şeful ONU declară că nu există o soluţie militară în Siria"
>>> model_inputs = tokenizer(src_text, text_target=tgt_text, return_tensors="pt")
>>> # model(**model_inputs) should workbuild_inputs_with_special_tokens
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 = None ) → 列表[int]
通过连接并添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。
MBART-50序列的格式如下，其中X表示序列
input_ids(解码器)[src_lang_code] X [eos]labels: (解码器)[tgt_lang_code] X [eos]
BOS never used. The expected use case for pair of sequences is not handled with a separator.
将特殊标记重置为源语言设置。前缀=[src_lang_code]，后缀=[eos]。
重置特殊标记为源语言设置。prefix=[src_lang_code]和suffix=[eos]。
MBartModel
类 transformers.MBartModel
< source >( config: MBartConfig )
参数
- config (MBartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载模型相关联的权重，只有配置。请查看 from_pretrained() 方法以加载模型权重。
裸MBART模型，输出原始隐藏状态，没有顶部特定头。这个模型继承自 PreTrainedModel。请查看超级类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入嵌入的大小、修剪头等。）
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与通用使用和行为相关的问题。
前向
< 源码 >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- 输入IDs (
torch.LongTensor形状(batch_size, sequence_length)) — 词汇表中的输入序列标记索引。如果您提供它，默认情况下会忽略填充。索引可以使用AutoTokenizer获取。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- 注意力掩码 (
torch.Tensor形状(batch_size, sequence_length)，可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]:- 1 对应于 未掩码 的标记，
- 0 对应于 掩码 的标记。
- decoder_input_ids (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) - 解码器输入序列单词在词汇表中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
MBart在解码器输入ID生成时使用特定的语言id标记作为开始标记，它根据源语言和目标语言而变化，例如，对于en_XX为25004，对于de_DE为25003。如果使用
past_key_values，则可选地只需要输入最后的decoder_input_ids（参见past_key_values）。在翻译和总结训练中，应该提供
decoder_input_ids。如果没有提供，模型将根据论文中的降噪预训练方法，通过向右移动input_ids来创建此张量。 - decoder_attention_mask (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) - 默认行为：生成一个张量，该张量忽略decoder_input_ids中的填充标记。默认情况下也将使用因果掩码。 - head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 用于取消编码器中注意力模块选择的头部掩码。掩码值选中范围在[0, 1]：- 1表示头部未掩码；
- 0表示头部被掩码。
- decoder_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于取消解码器中注意力模块选择的头部掩码。掩码值选中范围在[0, 1]：- 1表示头部未掩码；
- 0表示头部被掩码。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于取消解码器中交叉注意力模块选择的头部掩码。掩码值选中范围在[0, 1]：- 1表示头部未掩码；
- 0表示头部被掩码。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — 元组包含（last_hidden_state，可选：hidden_states，可选：attentions）。last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后层的隐藏状态序列。用于解码器的交叉注意力中。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的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输入）。 - 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索引转换为相关向量。 - use_cache （
bool，可选）— 如果设置为True，则返回past_key_values键值状态，并可用来加速解码（见past_key_values）。 - output_attentions （
bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的attentions张量。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详情，请参考返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而非普通元组。
返回值
transformers.modeling_outputs.Seq2SeqModelOutput或tuple(torch.FloatTensor)
当return_dict=False被传递或当config.return_dict=False时，这是一个transformers.modeling_outputs.Seq2SeqModelOutput或包含多个元素的torch.FloatTensor元组，这些元素取决于配置（MBartConfig）和输入。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后层的序列隐藏状态。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 在传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的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输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 包含嵌入层（如果有）输出和每个层的输出（如果有的话）的torch.FloatTensor元组。解码器在每个层的输出以及可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 每层一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
跨注意力 (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
shape=(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 模型编码器的最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果有嵌入层，则包含嵌入层的输出+每个层的输出）。编码器在每个层的输出处的隐藏状态加上可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
MBartModel的前向方法覆盖了__call__特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MBartModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = MBartModel.from_pretrained("facebook/mbart-large-cc25")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateclass transformers.MBartForConditionalGeneration
( config: MBartConfig )
参数
- config (MBartConfig) — 包含模型所有参数的配置类。使用配置文件初始化时，不会加载模型相关的权重，只有配置。请查阅 from_pretrained() 方法以加载模型权重。
具有语言建模头的 MBART 模型。可用于摘要，在微调预训练模型后使用。此模型继承自 PreTrainedModel。请检查超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与通用使用和行为相关的问题。
前向
< 来源 >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。如果您提供它，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask （形状为
(batch_size, sequence_length)的torch.Tensor，可选）—— 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]内：- 1 为未遮蔽的令牌，
- 0 为遮蔽的令牌。
- decoder_input_ids （形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选）—— 在词汇表中解码器输入序列令牌的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
MBart 使用特定语言 ID 令牌作为解码器输入 ID 的起始令牌，根据源语言和目标语言而异，例如，对于 en_XX 使用 25004，对于 de_DE 使用 25003。如果使用
past_key_values，则只需输入最后一批decoder_input_ids（请参阅past_key_values）。在翻译和摘要训练中，应提供
decoder_input_ids。如果未提供decoder_input_ids，则模型将根据论文的降噪预训练方法通过将输入 id 向右移位创建此张量。 - decoder_attention_mask （形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选） — 默认行为：生成一个忽略decoder_input_ids中的填充令牌的张量。默认还会使用因果掩码。 - head_mask （形状为
(encoder_layers, encoder_attention_heads)的torch.Tensor，可选） — 用于取消编码器中注意模块选择头部的掩码。选择掩码值在[0, 1]中：- 1 表示头部 未掩码，
- 0 表示头部 已掩码。
- decoder_head_mask （形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 用于取消解码器中注意模块选择头部的掩码。选择掩码值在[0, 1]中：- 1 表示头部 未掩码，
- 0 表示头部 已掩码。
- cross_attn_head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), optional) — 解码器中交叉注意力模块所选头部的掩码。掩码值选择在[0, 1]范围内：- 1 表示头部 未被掩码,
- 0 表示头部 已被掩码.
- encoder_outputs (
tuple(tuple(torch.FloatTensor), optional) — 元组包含 (last_hidden_state, optional:hidden_states, optional:attentions)，其中last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，optional) 表示编码器最后一层的隐藏状态序列。在解码器的交叉注意力中使用。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传递use_cache=True或当配置config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)的元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及两个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外张量。 包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（见past_key_values输入）以提高序列解码速度。 如果使用past_key_values，用户可以选择只输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将该模型的过去键值状态传递给此模型的）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), 可选) — 可以选择直接传递嵌入表示，而不传递input_ids。这在你想要比模型内部嵌入查找矩阵有更多控制权时很有用。 - decoder_inputs_embeds (
torch.FloatTensorof shape(batch_size, target_sequence_length, hidden_size), 可选) — 可选择不传递decoder_input_ids而直接传递嵌入表示。如果使用past_key_values，则可以只输入最后一个decoder_inputs_embeds（参见past_key_values）。如果想对将decoder_input_ids索引转换为相关向量的方式进行更多控制，此功能非常有用，比模型内部嵌入查找矩阵更有控制力。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values的键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。请参见返回的稠密张量中的hidden_states以获取更多详细信息。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言模型损失的标签。索引可以是[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），仅对标签在[0, ..., config.vocab_size]中的标记计算损失。
返回值
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 的元组（如果通过 return_dict=False 传递或者当 config.return_dict=False 时），包含根据配置（MBartConfig）和输入得到的各种元素。
-
loss (
torch.FloatTensor的形状为(1,)，可选，当提供labels时返回) — 语言模型损失。 -
logits （
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)）— 语言建模头部的预测分数（SoftMax前的每个词汇项的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 在传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的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输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 包含嵌入层（如果有）输出和每个层的输出（如果有的话）的torch.FloatTensor元组。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 每层一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
跨注意力 (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
shape=(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 模型编码器的最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果有嵌入层，则包含嵌入层的输出+每个层的输出）。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
MBartForConditionalGeneration 前向方法覆盖了__call__特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
译文示例
>>> from transformers import AutoTokenizer, MBartForConditionalGeneration
>>> model = MBartForConditionalGeneration.from_pretrained("facebook/mbart-large-en-ro")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-en-ro")
>>> example_english_phrase = "42 is the answer"
>>> inputs = tokenizer(example_english_phrase, return_tensors="pt")
>>> # Translate
>>> generated_ids = model.generate(**inputs, num_beams=4, max_length=5)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'42 este răspuns'掩码填充示例
>>> from transformers import AutoTokenizer, MBartForConditionalGeneration
>>> model = MBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> # de_DE is the language symbol id <LID> for German
>>> TXT = "</s> Meine Freunde sind <mask> nett aber sie essen zu viel Kuchen. </s> de_DE"
>>> input_ids = tokenizer([TXT], add_special_tokens=False, 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()
['nett', 'sehr', 'ganz', 'nicht', 'so']MBartForQuestionAnswering
class transformers.MBartForQuestionAnswering
< source >( config )
参数
- config （MBartConfig）— 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重，只加载数据配置。请查看from_pretrained()方法以加载模型权重。
MBART 模型顶部带有一个用于抽取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出之上有一个线性层，用于计算跨度起始 logits和跨度结束 logits）。
此模型继承自PreTrainedModel。请查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与通用使用和行为相关的问题。
前向
< source >( input_ids: Tensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None start_positions: Optional = None end_positions: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput或tuple(torch.FloatTensor)
参数
- input_ids （
torch.LongTensor，形状为(batch_size, sequence_length)） — 词汇表中的输入序列标记的索引。如果提供，则默认忽略填充。 - attention_mask （
torch.Tensor，形状为(batch_size, sequence_length)，可选） — 用于避免在对填充标记索引进行注意力操作的掩码。选择在[0, 1]范围内的掩码值： - decoder_input_ids （形状为
torch.LongTensor的(batch_size, target_sequence_length)，可选） — 词汇表中学位解码输入序列的索引。索引可以通过 AutoTokenizer 来获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
MBart 使用特定语言 id 标记作为
decoder_input_ids生成的起始标记，根据源语言和目标语言而异，例如，对于 en_XX 是 25004，对于 de_DE 是 25003。如果使用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中填充标记的张量。默认情况下还将使用因果掩码。 - head_mask (
torch.Tensor形状为(encoder_layers, encoder_attention_heads)，可选) — 去除编码器注意力模块中选定头的掩码。掩码值选择在[0, 1]：- 1 表示该头未屏蔽；
- 0 表示该头已屏蔽。
- decoder_head_mask (
torch.Tensor形状为(decoder_layers, decoder_attention_heads)，可选) — 去除解码器注意力模块中选定头的掩码。掩码值选择在[0, 1]：- 1 表示该头未屏蔽；
- 0 表示该头已屏蔽。
- cross_attn_head_mask (
torch.Tensor形状为(decoder_layers, decoder_attention_heads)，可选) — 去除解码器交叉注意力模块中选定头的掩码。掩码值选择在[0, 1]：- 1 表示该头未屏蔽；
- 0 表示该头已屏蔽。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — Tuple 由 (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时返回) — Tuple，包含长度为config.n_layers的tuple(torch.FloatTensor)，每个 tuple 包含 2 个 shape 为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及 2 个额外的 shape 为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。 - 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 替代普通元组。 - start_positions (形状为
(batch_size,的torch.LongTensor，可选) — 标记的区间开始的标签，用于计算标记分类损失。位置限制为序列长度（sequence_length）。序列外的位置在计算损失时不计。 - end_positions (形状为
(batch_size,的torch.LongTensor，可选) — 标记的区间结束的标签，用于计算标记分类损失。位置限制为序列长度（sequence_length）。序列外的位置在计算损失时不计。
返回值
transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或一个包含各种元素的 torch.FloatTensor 元组（如果 return_dict=False 被传递或当 config.return_dict=False 时），具体取决于配置（MBartConfig）和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当labels被提供时返回) — 总的区间提取损失是为开始和结束位置计算交叉熵的总和。 -
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(torch.FloatTensor)元组，每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及2个附加张量，形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 包含嵌入层（如果有）输出和每个层的输出（如果有的话）的torch.FloatTensor元组。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 每层一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
跨注意力 (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
shape=(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 模型编码器的最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果有嵌入层，则包含嵌入层的输出+每个层的输出）。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
MBartForQuestionAnswering 前向方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MBartForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = MBartForQuestionAnswering.from_pretrained("facebook/mbart-large-cc25")
>>> 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]
>>> # 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.lossMBartForSequenceClassification
类名 transformers.MBartForSequenceClassification
< 源代码 >( config: MBartConfig **kwargs )
参数
- config (MBartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载模型相关的权重，只有配置。检查from_pretrained()方法来加载模型权重。
MBart模型，顶部有一个序列分类的头（在池化输出之上的线性层），例如用于GLUE任务。
此模型继承自PreTrainedModel。请查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与通用使用和行为相关的问题。
前向
< source >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中的输入序列标记索引。如果提供，将默认忽略填充。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示已屏蔽的标记。
- decoder_input_ids (
torch.LongTensor形状(batch_size, target_sequence_length)， 可选）— 词汇表中的解码器输入序列标记的索引。可以通过使用 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
MBart 使用特定语言 id 标记作为
decoder_input_ids生成时的起始标记，具体取决于源语言和目标语言，例如，对于 en_XX 是 25004，对于 de_DE 是 25003。如果使用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中填充标记的张量。默认还会使用因果掩码。 - head_mask (
torch.Tensor的形状为(编码层, 编码注意头)，可选） — 用于禁用编码器中注意力模块选择的头的掩码。掩码值选择在[0, 1]之间：- 1 表示头未被掩码，
- 0 表示头被掩码。
- decoder_head_mask (
torch.Tensor的形状为(解码层, 解码注意头)，可选） — 用于禁用解码器中注意力模块选择的头的掩码。掩码值选择在[0, 1]之间：- 1 表示头未被掩码，
- 0 表示头被掩码。
- cross_attn_head_mask (
torch.Tensor的形状为(解码层, 解码注意头)，可选） — 用于禁用解码器中交叉注意力模块选择的头的掩码。掩码值选择在[0, 1]之间：- 1 表示头未被掩码，
- 0 表示头被掩码。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — Tuple 包含(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(torch.FloatTensor)的元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及两个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预计算的隐藏状态（自我注意块和交叉注意块中的键和值），可以在输入代码中用于加速顺序解码。
如果使用past_key_values，则用户可以选择仅输入最后一个decoder_input_ids（那些没有给此模型提供过去键值状态的）的形状为(batch_size, 1)而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选，您可以选择直接传递隐含表示，而不是传递input_ids。如果您需要比模型的内部嵌入查找矩阵更多的控制权来将input_ids索引转换为相关向量，这是一个有用的情况。 - decoder_inputs_embeds (
torch.FloatTensorof shape(batch_size, target_sequence_length, hidden_size), optional) — 可选，您可以选择直接传递隐含表示，而不是传递decoder_input_ids。如果使用past_key_values，则可选地只需输入最后一个decoder_inputs_embeds（参见past_key_values）。如果您需要比模型的内部嵌入查找矩阵更多的控制权来将decoder_input_ids索引转换为相关向量，这是一个有用的情况。如果decoder_input_ids和decoder_inputs_embeds都未设置，则decoder_inputs_embeds采用inputs_embeds的值。 - use_cache (
bool, optional) — 如果设置为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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 torch.FloatTensor 的一个元组（如果传入 return_dict=False 或当 config.return_dict=False），包含各种元素，具体取决于配置（MBartConfig）和输入。
-
loss （当提供
label时返回，torch.FloatTensor形状为(1,)，可选）— 分类（或回归，如果 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(torch.FloatTensor)元组，每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及2个附加张量，形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 包含嵌入层（如果有）输出和每个层的输出（如果有的话）的torch.FloatTensor元组。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 每层一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
跨注意力 (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
shape=(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 模型编码器的最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果有嵌入层，则包含嵌入层的输出+每个层的输出）。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
MBartForSequenceClassification 前向方法，重写了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, MBartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = MBartForSequenceClassification.from_pretrained("facebook/mbart-large-cc25")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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 = MBartForSequenceClassification.from_pretrained("facebook/mbart-large-cc25", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, MBartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = MBartForSequenceClassification.from_pretrained("facebook/mbart-large-cc25", 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 = MBartForSequenceClassification.from_pretrained(
... "facebook/mbart-large-cc25", 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).lossMBartForCausalLM
前向
< source >( input_ids: LongTensor = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状(batch_size, sequence_length)) — 输入序列词项在词汇表中的索引。如果提供，将默认忽略填充。 - attention_mask (
torch.Tensor形状(batch_size, sequence_length)，可选) — 避免在填充词索引上执行注意力的掩码。掩码值选择于[0, 1]: - encoder_hidden_states (
torch.FloatTensor形状(batch_size, sequence_length, hidden_size)，可选) — 解码器配置下的交叉注意力中使用，编码器最后一层的隐藏状态序列。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对编码器输入填充标记索引执行注意力的掩码。该掩码在配置为解码器时用于交叉注意力。掩码值在[0, 1]之间被选中： - head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), optional) — 异常权限查询浅层掩码以使注意力模块的选中的头部失效。掩码值在[0, 1]之间被选中：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- cross_attn_head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), optional) — 使交叉注意力模块中选中头部失效的掩码。掩码值在[0, 1]之间被选中：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- 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)的张量，和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外张量。这两个额外的张量只有在模型在序列到序列模型中作为解码器使用时才需要。 - labels （
torch.LongTensor形式，可选，形状为(batch_size, sequence_length)）— 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]范围内，或 -100（参见input_ids文档字符串）。设置为-100索引的标记将被忽略（掩码），损失只计算标签在[0, ..., config.vocab_size]范围内的标记。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values关键值状态，可用于加速解码（见past_key_values）。- 对于未屏蔽的词条，为 1；
- 对于屏蔽的词条，为 0。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。详见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层隐藏的状态。详见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是一个普通的元组。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个由 torch.FloatTensor 组成的元组（如果传递了 return_dict=False 或 config.return_dict=False）包含各种元素，这些元素取决于配置（MBartConfig）和输入。
-
loss (
torch.FloatTensor形状(1,), 可选，当提供labels时返回) — 语言模型损失（用于下一token的预测）。 -
logits （
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)）— 语言建模头部的预测分数（SoftMax前的每个词汇项的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True时或在config.output_hidden_states=True时返回) — 压缩为torch.FloatTensor的元组（对于具有嵌入层的模型，一个用于嵌入输出的输出，一个用于每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型的每个层的输出以及可选择的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True时或在config.output_attentions=True时返回) — 由torch.FloatTensor组成的元组（每个层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
-
跨注意力 (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax之后的交叉注意力权重，用于在交叉注意力头中的加权平均。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传递use_cache=True时或在config.use_cache=True时返回) — 一个长度为config.n_layers的torch.FloatTensor元组，其中每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置。只有在config.is_decoder = True时相关。包含预计算的隐藏状态（注意力块中的键和值），可用于（参看
past_key_values输入）以加速序列解码。
示例
>>> from transformers import AutoTokenizer, MBartForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = MBartForCausalLM.from_pretrained("facebook/mbart-large-cc25", 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
TrueTFMBartModel
类 transformers.TFMBartModel
< source >( config: MBartConfig *inputs **kwargs )
参数
- config (MBartConfig) — 带有 модели всех параметров的配置类。使用配置文件初始化不加载模型关联的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸MBART模型输出原始隐藏状态，不添加任何特定的头部。此模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入、修剪头部等）。
此模型也是 keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与其一般使用和行为相关的所有内容。
TensorFlow 中的模型和 layers 接受两种输入格式：
- 将所有输入都作为关键字参数（类似于 PyTorch 模型），或
- 将所有输入都作为一个包含在第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和 layers 时偏好此格式。正因如此，当使用如 model.fit() 这样的方法时，对于您来说事情应当“正好工作” - 您只需以 model.fit() 支持的任何格式传递您的输入和标签！然而，如果您想在 fit() 和 predict() 等Keras 方法之外使用第二种格式，例如创建自己的 layers 或模型时使用 Keras 的 Functional API，您可以使用以下三种方法来在第一个位置参数中收集所有的输入 Tensors：
- 只包含
input_ids的单个 Tensor：model(input_ids) - 长度可变的列表，包含在 docstring 中指定的一个或多个输入 Tensors：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 包含一个或多个与 docstring 中给出的输入名称关联的输入 Tensors 的字典：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，使用 子类化 创建模型和 layers 时，您不需要担心任何这些问题，因为您可以像向任何其他 Python 函数传递输入一样传递输入！
调用
< source >( input_ids: TFModelInputType = None attention_mask: tf.Tensor | None = None decoder_input_ids: tf.Tensor | None = None decoder_attention_mask: tf.Tensor | None = None decoder_position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None decoder_head_mask: tf.Tensor | None = None cross_attn_head_mask: tf.Tensor | None = None encoder_outputs: Optional[Union[Tuple, TFBaseModelOutput]] = None past_key_values: Tuple[Tuple[tf.Tensor]] | None = None inputs_embeds: tf.Tensor | None = None decoder_inputs_embeds: 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)) — 词库中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。详见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor的形状为(batch_size, sequence_length)，可选) — 避免在对填充标记索引执行注意力的掩码。掩码值选项为[0, 1]:- 1 表示 未掩码 的标记,
- 0 表示 掩码 的标记。
- decoder_input_ids（《tf.Tensor》形状为
(batch_size, target_sequence_length)，可选）— 词汇表中解码器输入序列标记的索引。可以使用AutoTokenizer来获取索引。详细信息请参阅PreTrainedTokenizer.encode() 和PreTrainedTokenizer.call()。
有关decoder input IDs的介绍，请参阅什么是decoder input IDs？
MBart使用特定语言id标记作为解码器decoder_input_ids的起始标记，根据源语言和目标语言的不同而变化，例如对于en_XX为25004，对于de_DE为25003。如果使用
past_key_values，则可以选择仅输入最后的decoder_input_ids（见past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果未提供decoder_input_ids，则模型将根据论文中的降噪预训练将input_ids向右移位以创建此张量。 - decoder_attention_mask（《tf.Tensor》形状为
(batch_size, target_sequence_length)，可选）— 默认情况下将创建并忽略填充标记。对于大多数使用场景，不建议设置此参数。 - decoder_position_ids (
tf.Tensorof shape(batch_size, sequence_length), 可选) — 每个解码器输入序列标记在位置嵌入中的位置索引。选择在范围[0, config.max_position_embeddings - 1]内。 - head_mask (
tf.Tensorof shape(encoder_layers, encoder_attention_heads), 可选) — 用于在编码器中屏蔽注意模块选择头部的掩码。掩码值选择在[0, 1]内：- 1 表示头部 未屏蔽，
- 0 表示头部 已屏蔽。
- decoder_head_mask (
tf.Tensorof shape(decoder_layers, decoder_attention_heads), 可选) — 用于在解码器中屏蔽注意模块选择头部的掩码。掩码值选择在[0, 1]内：- 1 表示头部 未屏蔽，
- 0 表示头部 已屏蔽。
- 交叉注意力模块选定的头部取消掩码的掩码（
tf.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选） — 使用值[0, 1]在下列中选择的掩码值：- 1 表示头部未被掩码
- 0 表示头部被掩码
- encoder_outputs（编码器输出的隐藏状态，可选） — 解码器交叉注意力中使用。形状为
(batch_size, sequence_length, hidden_size)的是序列。 - past_key_values（长度为
config.n_layers的Tuple[Tuple[tf.Tensor]]） — 包含注意力块预计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择只输入最后的decoder_input_ids（那些没有向此模型提供过去键值状态的）的形状为(batch_size, 1)而不是所有decoder_input_ids的形状为(batch_size, sequence_length)。 - inputs_embeds (
tf.Tensor的shape为(batch_size, sequence_length, hidden_size)，可选) — 可选地，而不是传递input_ids，您可以选择直接传递嵌入表示。这对于您想要比模型内部嵌入查找矩阵有更多控制如何将input_ids索引转换为相关向量是有用的。 - use_cache (
bool，可选，默认为True) — 如果设置为True，则返回past_key_values键-value状态，并可用于加速解码（见past_key_values）。在训练期间设置为False，在生成期间设置为True。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数仅在急切模式下使用，在图模式下，将使用配置中的值。 - output-hidden-states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请见返回张量下的hidden-states。此参数仅在急切模式下有效，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是普通元组。此参数可用于急切模式，在图模式下此值将始终设置为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），它包括根据配置和输入的不同元素（MBartConfig）。
-
last-hidden-state (
tf.Tensor形状为(批大小, 序列长度, 隐藏尺寸)) — 解码器输出最后一层的隐藏状态序列。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past-key-values (
tf.Tensor列表，可选，在通过use_cache=True传递或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, 批大小, num_heads, 序列长度, 每个头的嵌入尺寸)。包含解码器的预计算隐藏状态（注意力的键和值），这些状态可以用作（请参阅
past_key_values输入）来加速顺序解码。 -
decoder_hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个形状为(batch_size, sequence_length, hidden_size)的tf.Tensor的元组（包括嵌入层的输出和每层输出）。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后层的隐藏状态的序列。 -
encoder_hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个形状为(batch_size, sequence_length, hidden_size)的tf.Tensor的元组（包括嵌入层的输出和每层的输出）。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
TFMBartModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMBartModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = TFMBartModel.from_pretrained("facebook/mbart-large-cc25")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFMBartModel
class transformers.TFMBartForConditionalGeneration
< source >( config *inputs **kwargs )
参数
- config (MBartConfig) — 模型配置类，包含所有模型参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
带语言模型头的MBART模型。在进行微调预训练模型后可用于总结。此模型继承自 TFPreTrainedModel。请查看超类的文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与其一般使用和行为相关的所有内容。
TensorFlow 中的模型和 layers 接受两种输入格式：
- 将所有输入都作为关键字参数（类似于 PyTorch 模型），或
- 将所有输入都作为一个包含在第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和 layers 时偏好此格式。正因如此，当使用如 model.fit() 这样的方法时，对于您来说事情应当“正好工作” - 您只需以 model.fit() 支持的任何格式传递您的输入和标签！然而，如果您想在 fit() 和 predict() 等Keras 方法之外使用第二种格式，例如创建自己的 layers 或模型时使用 Keras 的 Functional API，您可以使用以下三种方法来在第一个位置参数中收集所有的输入 Tensors：
- 只包含
input_ids的单个 Tensor：model(input_ids) - 长度可变的列表，包含在 docstring 中指定的一个或多个输入 Tensors：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 包含一个或多个与 docstring 中给出的输入名称关联的输入 Tensors 的字典：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，使用 子类化 创建模型和 layers 时，您不需要担心任何这些问题，因为您可以像向任何其他 Python 函数传递输入一样传递输入！
调用
< source >( input_ids: TFModelInputType = None attention_mask: tf.Tensor 或 None = None decoder_input_ids: tf.Tensor 或 None = None decoder_attention_mask: tf.Tensor 或 None = None decoder_position_ids: tf.Tensor 或 None = None head_mask: tf.Tensor 或 None = None decoder_head_mask: tf.Tensor 或 None = None cross_attn_head_mask: tf.Tensor 或 None = None encoder_outputs: Optional[TFBaseModelOutput] 或 None past_key_values: Tuple[Tuple[tf.Tensor]] 或 None inputs_embeds: tf.Tensor 或 None decoder_inputs_embeds: tf.Tensor 或 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 training: Optional[bool] 或 False ) → transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor的形状({0})) — 词汇表中的输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor的形状({0})，可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]范围内：- 1 代表 未掩码 的标记
- 0 代表 掩码 的标记
- decoder_input_ids (
tf.Tensorof shape(batch_size, target_sequence_length), 可选) —— 解码器输入序列的词汇索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
MBart 使用特定的语言 ID 标记作为
decoder_input_ids生成的起始标记，这会因源语言和目标语言而异，例如 en_XX 使用 25004，而 de_DE 使用 25003。如果使用past_key_values，则只需要输入最后的一些decoder_input_ids（有关past_key_values的详细信息）。对于翻译和摘要训练，应提供
decoder_input_ids。如果没有提供，模型将根据论文中使用的方法通过右移input_ids来创建此张量进行去噪预训练。 - decoder_attention_mask (
tf.Tensorof shape(batch_size, target_sequence_length), 可选) —— 默认情况下将生成，并忽略填充标记。对于大多数用例不建议设置此项。 - decoder_position_ids (
tf.Tensorof shape(batch_size, sequence_length), 可选) — 每个解码器输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
tf.Tensorof shape(encoder_layers, encoder_attention_heads), 可选) — 用于关闭编码器中注意力模块的选中头的掩码。掩码值选择在[0, 1]:- 1 表示该头 未掩码,
- 0 表示该头 已掩码.
- decoder_head_mask (
tf.Tensorof shape(decoder_layers, decoder_attention_heads), 可选) — 用于关闭解码器中注意力模块的选中头的掩码。掩码值选择在[0, 1]:- 1 表示该头 未掩码,
- 0 表示该头 已掩码.
- cross_attn_head_mask (
tf.Tensor形状(decoder_layers, decoder_attention_heads), 可选) — 用于取消跨注意力模块中选定头的掩码。掩码值选择在[0, 1]之间：- 1 表示该头 未掩码,
- 0 表示该头 已掩码.
- encoder_outputs (
tf.FloatTensor, 可选) — 编码器最后一层的隐藏状态。用于解码器的跨注意力操作。形状为(batch_size, sequence_length, hidden_size)是序列。 - past_key_values (
Tuple[Tuple[tf.Tensor]]长度为config.n_layers) — 包含预先计算的关注块的关键隐藏状态和值。可用于加速解码。如果使用past_key_values，用户可以选择仅输入decoder_input_ids的最后一个(batch_size, 1)（那些没有将过去的关键值状态提供给此模型的），而不是所有decoder_input_ids的形状(batch_size, sequence_length)。 - inputs_embeds (
tf.Tensor的形状为(batch_size, sequence_length, hidden_size)，可选) — 可以选择直接传递嵌入表示，而不是传递input_ids，这是如果您想比模型的嵌入查找矩阵有更多控制权如何转换input_ids索引到相关向量时很有用。 - use_cache (
bool，可选，默认为True） — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。在训练期间设置为False，在生成期间设置为True。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。此参数只能在eager模式中使用，在graph模式中，将使用配置中的值。 - output_hidden_states (
布尔值, 可选) — 是否返回所有层的隐藏状态。详见返回的张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
布尔值, 可选) — 是否返回 ModelOutput 而非普通元组。此参数可以在 eager 模式下使用，在 graph 模式下该值总是设置为 True。 - training (
布尔值, 可选, 默认为False) — 是否使用模型在训练模式下（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应位于[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）。设置为-100的索引的标记将被忽略（掩码），只有标签在[0, ..., config.vocab_size]内的标记才会计算损失。
返回值
transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或一个包含各种元素的 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），这些元素取决于配置（MBartConfig）和输入。
-
loss (
tf.Tensorof shape(n,), optional，其中 n 是未掩码标签的数量，当提供labels时返回) — 语言建模损失。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇表的分数）。 -
past-key-values (
tf.Tensor列表，可选，在通过use_cache=True传递或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, 批大小, num_heads, 序列长度, 每个头的嵌入尺寸)。包含解码器的预计算隐藏状态（注意力的键和值），这些状态可以用作（请参阅
past_key_values输入）来加速顺序解码。 -
decoder_hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个形状为(batch_size, sequence_length, hidden_size)的tf.Tensor的元组（包括嵌入层的输出和每层输出）。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后层的隐藏状态的序列。 -
encoder_hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个形状为(batch_size, sequence_length, hidden_size)的tf.Tensor的元组（包括嵌入层的输出和每层的输出）。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder_attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每层一个）。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
TFMBartForConditionalGeneration 前向方法，覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
译文示例
>>> from transformers import AutoTokenizer, TFMBartForConditionalGeneration
>>> model = TFMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-en-ro")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-en-ro")
>>> example_english_phrase = "42 is the answer"
>>> inputs = tokenizer(example_english_phrase, return_tensors="tf")
>>> # Translate
>>> generated_ids = model.generate(**inputs, num_beams=4, max_length=5)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'42 este răspuns'掩码填充示例
>>> from transformers import AutoTokenizer, TFMBartForConditionalGeneration
>>> import tensorflow as tf
>>> model = TFMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> # de_DE is the language symbol id <LID> for German
>>> TXT = "</s> Meine Freunde sind <mask> nett aber sie essen zu viel Kuchen. </s> de_DE"
>>> input_ids = tokenizer([TXT], add_special_tokens=False, return_tensors="tf")["input_ids"]
>>> logits = model(input_ids).logits
>>> masked_index = tf.where(input_ids[0] == tokenizer.mask_token_id)[0, 0]
>>> probs = tf.nn.softmax(logits[0, masked_index], axis=0)
>>> values, predictions = tf.math.top_k(probs, 5)
>>> tokenizer.decode(predictions).split()
['nett', 'sehr', 'ganz', 'nicht', 'so']FlaxMBartModel
class transformers.FlaxMBartModel
< source >( config: MBartConfig input_shape: 元组 = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (MBartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选，默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPUs上）这可用于在GPU或TPUs上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype进行。请注意，这仅指定计算的数据类型，不会影响模型参数的数据类型。
直接输出原始隐藏状态而不带有任何特定头部层的MBart模型。此模型继承自 FlaxPreTrainedModel。查看超级类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、剪枝头部等。）
该模型同时也是一个 Flax Linen flax.nn.Module 子类。将其作为普通的 Flax 模块使用，并查阅 Flax 文档以了解所有关于通用用法和行为的相关内容。
最后，该模型支持以下固有的 JAX 功能：
__call__
< source >( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids （形状为
(batch_size, sequence_length)的jnp.ndarray） —词汇表中的输入序列标记索引。如提供padding，默认将忽略。 - attention_mask （形状为
(batch_size, sequence_length)的jnp.ndarray，可选） — 稀疏mask，以避免对padding token索引执行注意力操作。mask值选择在[0, 1]：- 1表示非mask的token，
- 0表示mask的token。
- decoder_input_ids (
jnp.ndarrayof shape(batch_size, target_sequence_length), optional) — 词汇表中的解码器输入序列词索引。可以使用 AutoTokenizer 获取索引。更详细的信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
在翻译和摘要训练中，应提供
decoder_input_ids。如果没有提供decoder_input_ids，则模型将根据论文中的去噪预训练方法创建此张量，将input_ids向右移动。 - decoder_attention_mask (
jnp.ndarrayof shape(batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，该张量忽略decoder_input_ids中的填充令牌。默认情况下还会使用因果关系掩码。如果您想更改填充行为，请根据您的需求进行修改。有关默认策略的更多信息，请参阅论文中的图 1。
- position_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 每个输入序列令牌在位置嵌入中的位置索引。在范围[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.FlaxSeq2SeqModelOutput 或 torch.FloatTensor 的元组
一个 transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置和输入（例如 MBartConfig）。
-
last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后层的隐藏状态序列。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past_key_values (
tuple(tuple(jnp.ndarray))，可选），在传递use_cache=True或当config.use_cache=True时返回 — 包含长度为config.n_layers的tuple(jnp.ndarray)，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后层的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder Attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
FlaxMBartPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxMBartModel
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = FlaxMBartModel.from_pretrained("facebook/mbart-large-cc25")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateencode
< source >( input_ids: Array attention_mask: Optional = None position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarrayof shape(batch_size, sequence_length)) — Vocabulary中的输入序列标记的索引。如提供，默认将忽略填充。可以使用AutoTokenizer获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- attention_mask (
jnp.ndarrayof shape(batch_size, sequence_length), optional) — 用于避免在填充词索引上执行注意力的掩码。掩码值在[0, 1]中选取：- 1 代表 未掩码 的词
- 0 代表 掩码 的词
- position_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 每个输入序列的词在位置嵌入中的索引。选取范围在[0, config.max_position_embeddings - 1]。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。详见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关返回张量下的hidden_states的详细信息，请参阅。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。
返回值
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个由 torch.FloatTensor 组成的元组（如果 return_dict=False 传入或当 config.return_dict=False）并包含根据配置（<class 'transformers.models.mbart.configuration_mbart.MBartConfig'>）和输入的元素。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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)解码
< source >( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)
参数
- decoder_input_ids （形状为
(batch_size, target_sequence_length)的jnp.ndarray） — 词汇表中的解码输入序列标记的索引。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 - encoder_outputs （形状为
(batch_size, sequence_length, hidden_size)的tuple(tuple(jnp.ndarray))） — 包含(last_hidden_state, optional: hidden_states, optional: attentions)的一组元组，其中last_hidden_state是编码器输出最后层的隐藏状态序列。用于解码器的交叉注意力。 - encoder_attention_mask （形状为
(batch_size, sequence_length)的jnp.ndarray） — 用于防止对填充标记索引进行关注的有效掩码。掩码选择值在[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）。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 在传递use_cache=True时返回，或在当config.use_cache=True时返回) — 长度为config.n_layers的tuple(jnp.ndarray)的元组，每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 2 个张量，可选地，如果config.is_encoder_decoder=True，还包含形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的 2 个额外张量。包含预计算的隐藏状态（自注意力块中的键和值，以及可选地在交叉注意力块中若
config.is_encoder_decoder=True），这些状态可用于（参见past_key_values输入）来加速顺序解码。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
-
交叉注意力 （
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)）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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_stateFlaxMBartForConditionalGeneration
类 transformers.FlaxMBartForConditionalGeneration
< source >( config: MBartConfig input_shape: 元组 = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config （MBartConfig） — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只有配置。查看 from_pretrained() 方法加载模型权重。
- dtype (
jax.numpy(dtype，可选，默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）。这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定了，所有计算都将使用给定的
dtype进行。请注意，这仅指定了计算的数据类型，并不影响模型参数的数据类型。
带有语言建模头的MMBart模型。可用于摘要。此模型继承自FlaxPreTrainedModel。检查超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
该模型同时也是一个 Flax Linen flax.nn.Module 子类。将其作为普通的 Flax 模块使用，并查阅 Flax 文档以了解所有关于通用用法和行为的相关内容。
最后，该模型支持以下固有的 JAX 功能：
__call__
< source >( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarrayof shape(batch_size, sequence_length)) — 词典中输入序列标记的索引。如果您提供填充，则默认忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask （形状为
(batch_size, sequence_length)的jnp.ndarray，可选）— 避免在填充令牌索引上执行注意力的掩码。掩码值选择在[0, 1]： - decoder_input_ids （形状为
(batch_size, target_sequence_length)的jnp.ndarray，可选）— 解码器输入序列令牌在词汇表中的索引。 - decoder_attention_mask （形状为
(batch_size, target_sequence_length)的jnp.ndarray，可选）— 默认行为：生成一个张量，该张量忽略decoder_input_ids中的填充令牌。默认情况下还会使用因果掩码。 - 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)
A transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或一个由 torch.FloatTensor 组成的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含的元素根据配置（MBartConfig）和输入而有所不同。
-
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(jnp.ndarray)，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后层的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder Attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
FlaxMBartPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
摘要示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration, MBartConfig
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> ARTICLE_TO_SUMMARIZE = "Meine Freunde sind cool, aber sie essen zu viel Kuchen."
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="np")
>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=4, max_length=5).sequences
>>> print(tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False))掩码填充示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> # de_DE is the language symbol id <LID> for German
>>> TXT = "</s> Meine Freunde sind <mask> nett aber sie essen zu viel Kuchen. </s> de_DE"
>>> input_ids = tokenizer([TXT], add_special_tokens=False, return_tensors="np")["input_ids"]
>>> logits = model(input_ids).logits
>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero()[0].item()
>>> probs = logits[0, masked_index].softmax(dim=0)
>>> values, predictions = probs.topk(5)
>>> tokenizer.decode(predictions).split()encode
< 来源 >( input_ids: Array attention_mask: Optional = None position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
参数
- input_ids （形状为
(batch_size, sequence_length)的jnp.ndarray）—词汇表中的输入序列标记的索引。如果您提供了它，则默认会忽略填充。可以使用AutoTokenizer获取索引。了解更多详情，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- attention_mask （形状为
(batch_size, sequence_length)的jnp.ndarray，可选）—避免在填充标记的索引上执行注意力的掩码。在[0, 1]中选择的掩码值：- 1对于未掩码的标记，
- 0对于掩码的标记。
- position_ids （形状为
(batch_size, sequence_length)的numpy.ndarray，可选）—每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - output_attentions (
布尔值, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
布尔值, 可选) — 是否返回所有层的隐藏状态。更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
布尔值, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
返回值
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个由 torch.FloatTensor 组成的元组（如果 return_dict=False 传入或当 config.return_dict=False）并包含根据配置（<class 'transformers.models.mbart.configuration_mbart.MBartConfig'>）和输入的元素。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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_input_ids encoder_outputs encoder_attention_mask: 可选 = None decoder_attention_mask: 可选 = None decoder_position_ids: 可选 = None past_key_values: 字典 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: 布尔 = False params: 字典 = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- decoder_input_ids (
jnp.ndarray形状(batch_size, target_sequence_length)) — 词汇中的解码器输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详情，请参阅 PreTrainedTokenizer.encode() 以及 PreTrainedTokenizer.call()。
对于翻译和摘要训练，应提供
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)，可选) — 用于防止在填充令牌索引上执行注意力的掩码。掩码值的选项是：- 1 对应于 未掩码 的令牌，
- 0 对应于 掩码 的令牌。
- decoder_attention_mask （形状为
(batch_size, target_sequence_length)的jnp.ndarray，可选） — 默认行为：生成一个忽略decoder_input_ids中的填充标记的张量。默认还会使用因果掩码。如果需要改变填充行为，应根据需求进行修改。有关默认策略的更多信息，请参阅该论文中的图1。
- decoder_position_ids （形状为
(batch_size, sequence_length)的numpy.ndarray，可选） — 每个解码器输入序列标记在位置嵌入中的索引。从[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）。
-
logits (
jnp.ndarray形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇的分数）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
-
cross_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的交叉注意力权重，用于在交叉注意力头中的加权平均。
-
past_key_values (
tuple(tuple(jnp.ndarray))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的jnp.ndarray元组对的元组，每个对包含如果模型以编码器-解码器模式使用时，缓存的自注意力和交叉注意力层的键、值状态。只有当config.is_decoder = True时才相关。包含预计算的隐藏状态（注意力块中的键和值），可用于（参看
past_key_values输入）以加速序列解码。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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.logitsFlaxMBartForSequenceClassification
类 transformers.FlaxMBartForSequenceClassification
< 源代码 >( config: MBartConfig input_shape: 元组 = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (MBartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时不加载与模型关联的权重，只有配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认jax.numpy.float32) — 计算的数据类型。可以是以下之一：jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定了所有计算都将使用给定的
dtype进行。请注意，这仅指定了计算的数据类型，对模型参数的数据类型无影响。
MBart模型，顶部有一个序列分类的头（在池化输出之上的线性层），例如用于GLUE任务。
此模型继承自 FlaxPreTrainedModel。请查阅超类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型同时也是一个 Flax Linen flax.nn.Module 子类。将其作为普通的 Flax 模块使用，并查阅 Flax 文档以了解所有关于通用用法和行为的相关内容。
最后，该模型支持以下固有的 JAX 功能：
__call__
< source >( input_ids: 数组 attention_mask: 可选 = None decoder_input_ids: 可选 = None decoder_attention_mask: 可选 = None position_ids: 可选 = None decoder_position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: 布尔 = False params: 字典 = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarray形状(batch_size, sequence_length)) — 词汇中的输入序列标记的索引。如果提供，默认将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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, optional) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回值
transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
返回 transformers.modeling_flax_outputs.FlaxSeq2SeqSequenceClassifierOutput 或是一个包含多个元素的元组，这些元素根据配置（MBartConfig）和输入而有所不同，如果传递了 return_dict=False 或当配置 return_dict=False 时，则为 torch.FloatTensor。
-
logits (
jnp.ndarrayof shape(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(jnp.ndarray)，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后层的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder Attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
FlaxMBartPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = FlaxMBartForSequenceClassification.from_pretrained("facebook/mbart-large-cc25")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsencode
< source >( input_ids: Array attention_mask: Optional = None position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
参数
- input_ids （形状为
(batch_size, sequence_length)的jnp.ndarray） — 词汇表中输入序列标记的索引。提供填充时默认会忽略填充。 - attention_mask （形状为
(batch_size, sequence_length)的jnp.ndarray，可选） — 避免在填充标记索引上执行注意力的掩码。掩码值选自[0, 1]： - position_ids （形状为
(batch_size, sequence_length)的numpy.ndarray，可选） — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[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)
A transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个由 torch.FloatTensor 组成的元组（如果 return_dict=False 传入或当 config.return_dict=False）并包含根据配置（<class 'transformers.models.mbart.configuration_mbart.MBartConfig'>）和输入的元素。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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)解码
< source >( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)
参数
- decoder_input_ids (
jnp.ndarrayof shape(batch_size, target_sequence_length)) — 解码器输入序列token在词汇表中的索引。索引可以使用AutoTokenizer获取。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
在翻译和摘要训练中，应提供
decoder_input_ids。如果没有提供decoder_input_ids，则模型将根据论文中的去噪预训练方案，通过将input_ids向右移动来创建此张量。 - encoder_outputs (
tuple(tuple(jnp.ndarray)) — Tuple consists of (last_hidden_state, optional:hidden_states, optional:attentions)last隐藏状态of shape(batch_size, sequence_length, hidden_size), optional) is a sequence of hidden-states at the output of the last layer of the encoder. Used in the cross-attention of the decoder. - 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：[链接](https://arxiv.org/abs/1910.13461)。
- 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》可选）— 是否返回所有注意层张量的注意力。有关更多详细信息，请参阅返回的 tensors 下的
attentions。 - output_hidden_states（《bool》可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的 tensors 下的
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）。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 在传递use_cache=True时返回，或在当config.use_cache=True时返回) — 长度为config.n_layers的tuple(jnp.ndarray)的元组，每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 2 个张量，可选地，如果config.is_encoder_decoder=True，还包含形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的 2 个额外张量。包含预计算的隐藏状态（自注意力块中的键和值，以及可选地在交叉注意力块中若
config.is_encoder_decoder=True），这些状态可用于（参见past_key_values输入）来加速顺序解码。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
-
交叉注意力 （
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)）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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_stateFlaxMBartForQuestionAnswering
class transformers.FlaxMBartForQuestionAnswering
< source >( config: MBartConfig input_shape: 元组 = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (MBartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时不加载模型相关的权重，只加载配置。查看from_pretrained()方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32，jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）。这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定了所有计算都将使用给定的dtype来执行。
MBart模型带有一个用于QAP（如SQuAD）的span分类头（在hidden-states输出上有一个线性层来计算span start logits和span end logits）。
此模型继承自 FlaxPreTrainedModel。请查阅超类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入的大小、剪枝头部等）。
该模型同时也是一个 Flax Linen flax.nn.Module 子类。将其作为普通的 Flax 模块使用，并查阅 Flax 文档以了解所有关于通用用法和行为的相关内容。
最后，该模型支持以下固有的 JAX 功能：
__call__
< source >( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqQuestionAnsweringModelOutput or tuple(torch.FloatTensor)
参数
- input_ids （格式为
jnp.ndarray的形状为(batch_size, sequence_length)的数组）— 输入序列token在词典中的索引。如果您提供它，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask （形状为
jnp.ndarray的形状为(batch_size, sequence_length)的数组，可选）— 避免在填充token索引上执行注意力的掩码。掩码值在[0 ,1]中选择：- 1 表示 未掩码 的token ，
- 0 表示 掩码 的token。
- decoder_input_ids (
jnp.ndarrayof shape(batch_size, target_sequence_length), optional) — 词汇表中的解码器输入序列标记的索引。可以使用 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call().
在翻译和摘要训练中，应提供
decoder_input_ids。如果没有提供decoder_input_ids，模型将根据文献中的去噪预训练方法创建此张量，将input_ids向右移动。 - decoder_attention_mask (
jnp.ndarrayof shape(batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，忽略decoder_input_ids中的填充标记。默认情况下还会使用因次掩码。如果您想更改填充行为，请根据需求进行修改。更多信息请参阅 该文献 中的图1。
- position_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 在位置嵌入中的每个输入序列标记的位置索引。选择在范围[0, config.max_position_embeddings - 1]内。 - decoder_position_ids （形状为
(batch_size, sequence_length)的numpy.ndarray，可选）— 每个解码输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - output_attentions （
bool，可选）— 是否返回所有注意力层的注意力张量。有关更多信息，请参阅返回张量下的attentions。 - output_hidden_states （
bool，可选）— 是否返回所有层的隐藏状态。有关更多信息，请参阅返回张量下的hidden_states。 - return_dict （
bool，可选）— 是否返回一个 ModelOutput 而不是一个普通的元组。
返回值
transformers.modeling_flax_outputs.FlaxSeq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_flax_outputs.FlaxSeq2SeqQuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，这取决于配置（MBartConfig）和输入。
-
start_logits （形状为
(batch_size, sequence_length)的jnp.ndarray）—— Span 开始的分数（SoftMax 之前）。 -
end_logits （形状为
(batch_size, sequence_length)的jnp.ndarray）—— Span 结束的分数（SoftMax 之前）。 -
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)的张量，以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
-
encoder_last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后层的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)，可选），在传递output_hidden_states=True或当config.output_hidden_states=True时返回 — 包含jnp.ndarray的元组（一个是词嵌入输出，另一个是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出时的隐藏状态加上初始嵌入输出。
-
encoder Attentions (
tuple(jnp.ndarray)，可选），在传递output_attentions=True或当config.output_attentions=True时返回 — 包含每个层的jnp.ndarray的元组，形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力softmax之后使用，用于计算自注意力头中的加权的平均值。
FlaxMBartPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义前向传递的配方，但应该在函数调用之后调用Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> model = FlaxMBartForQuestionAnswering.from_pretrained("facebook/mbart-large-cc25")
>>> 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_logitsencode
< 来源 >( input_ids: Array attention_mask: Optional = None position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
参数
- input_ids （形状为
(batch_size, sequence_length)的jnp.ndarray）—— 词表中的输入序列标记的索引。如果提供，则默认忽略填充。 使用 AutoTokenizer 可以获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 - attention_mask (形状为
(batch_size, sequence_length)的jnp.ndarray，可选) — 防止对填充标记索引执行注意力的掩码。掩码值范围为[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- position_ids (形状为
(batch_size, sequence_length)的numpy.ndarray，可选) — 每个输入序列标记在位置嵌入中的位置的索引。范围选择在[0, config.max_position_embeddings - 1]。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量中的attentions。 - 输出隐藏状态 (
bool, 可选) — 是否返回所有层级的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - 返回字典 (
bool, 可选) — 是否返回一个 ModelOutput 而不是纯元组。
返回值
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个由 torch.FloatTensor 组成的元组（如果 return_dict=False 传入或当 config.return_dict=False）并包含根据配置（<class 'transformers.models.mbart.configuration_mbart.MBartConfig'>）和输入的元素。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)
参数
decoder_input_ids (
jnp.ndarrayof shape(batch_size, target_sequence_length)) — 词汇表中的解码器输入序列标记的索引。索引可以使用AutoTokenizer获取。请参见PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()以获取详细信息。
对于翻译和摘要训练，应提供
decoder_input_ids。如果未提供decoder_input_ids，则模型将根据论文中的方法通过将input_ids向右平移来创建此张量。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, 可选) — 是否返回所有注意力的张量。Seeattentionsunder returned tensors for more detail. - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。Seehidden_statesunder returned tensors for more detail. - 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）。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。past_key_values被使用时，仅输出序列的最后隐藏状态，形状为(batch_size, 1, hidden_size)。 -
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 在传递use_cache=True时返回，或在当config.use_cache=True时返回) — 长度为config.n_layers的tuple(jnp.ndarray)的元组，每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 2 个张量，可选地，如果config.is_encoder_decoder=True，还包含形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的 2 个额外张量。包含预计算的隐藏状态（自注意力块中的键和值，以及可选地在交叉注意力块中若
config.is_encoder_decoder=True），这些状态可用于（参见past_key_values输入）来加速顺序解码。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当output_hidden_states=True传入或当config.output_hidden_states=True）— 一个jnp.ndarray的元组（一个用于嵌入输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型的每层输出隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当output_attentions=True传入或当config.output_attentions=True）— 一个jnp.ndarray的元组（每一层的），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力softmax之后的注意力权重，用于在自注意力头中的加权平均。
-
交叉注意力 （
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)）。解码器的跨注意力层的注意力权重，在注意力softmax之后使用，用于计算跨注意力头中的加权的平均值。
示例
>>> from transformers import AutoTokenizer, FlaxMBartForConditionalGeneration
>>> model = FlaxMBartForConditionalGeneration.from_pretrained("facebook/mbart-large-cc25")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/mbart-large-cc25")
>>> 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