Transformers 文档
FSMT
并获得增强的文档体验
开始使用
FSMT
概述
FSMT (FairSeq MachineTranslation) 模型由 Nathan Ng、Kyra Yee、Alexei Baevski、Myle Ott、Michael Auli、Sergey Edunov 在 Facebook FAIR’s WMT19 News Translation Task Submission 一文中提出。
论文摘要如下：
本文介绍了 Facebook FAIR 在 WMT19 新闻翻译共享任务中的提交方案。我们参加了两个语言对和四个翻译方向：英语 <-> 德语和英语 <-> 俄语。延续去年的提交方案，我们的基线系统是基于 BPE 的大型 Transformer 模型，使用 Fairseq 序列建模工具包进行训练，并依赖于采样反向翻译。今年我们尝试了不同的双语数据过滤方案，以及添加经过滤的反向翻译数据。我们还对模型进行集成和特定领域数据微调，然后使用带噪声的信道模型进行重排序解码。我们的提交方案在人工评估的四个翻译方向上均排名第一。在英译德任务中，我们的系统显著优于其他系统及人类翻译。该系统比我们在 WMT'18 提交的方案提升了 4.5 个 BLEU 分数。
实现说明
- FSMT 使用独立的源语言和目标语言词汇表，二者并未合并。它也不共享词元嵌入。其分词器与 XLMTokenizer 非常相似，主模型派生自 BartModel。
FSMTConfig
class transformers.FSMTConfig
< 源代码 >( langs = ['en', 'de'] src_vocab_size = 42024 tgt_vocab_size = 42024 activation_function = 'relu' d_model = 1024 max_length = 200 max_position_embeddings = 1024 encoder_ffn_dim = 4096 encoder_layers = 12 encoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_ffn_dim = 4096 decoder_layers = 12 decoder_attention_heads = 16 decoder_layerdrop = 0.0 attention_dropout = 0.0 dropout = 0.1 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 2 is_encoder_decoder = True scale_embedding = True tie_word_embeddings = False num_beams = 5 length_penalty = 1.0 early_stopping = False use_cache = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 forced_eos_token_id = 2 **common_kwargs )
参数
- langs (
list[str]) — 包含源语言和目标语言的列表（例如 `['en', 'ru']`）。 - src_vocab_size (
int) — 编码器的词汇表大小。定义了编码器中前向方法 `inputs_ids` 可以表示的不同词元的数量。 - tgt_vocab_size (
int) — 解码器的词汇表大小。定义了解码器中前向方法 `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) — 编码器中“中间层”（通常称为前馈层）的维度。 - activation_function (
str或Callable, 可选, 默认为"relu") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果为字符串，支持 `"gelu"`、`"relu"`、`"silu"` 和 `"gelu_new"`。 - dropout (
float, 可选, 默认为 0.1) — 嵌入层、编码器和池化层中所有全连接层的丢弃概率。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的丢弃率。 - activation_dropout (
float, 可选, 默认为 0.0) — 全连接层内激活函数的丢弃率。 - max_position_embeddings (
int, 可选, 默认为 1024) — 该模型可能使用的最大序列长度。通常设置为一个较大的值以备不时之需（例如 512、1024 或 2048）。 - init_std (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - scale_embedding (
bool, 可选, 默认为True) — 是否通过除以 sqrt(d_model) 来缩放嵌入。 - bos_token_id (
int, 可选, 默认为 0) — 序列开始词元的 ID。 - pad_token_id (
int, 可选, 默认为 1) — 填充词元的 ID。 - eos_token_id (
int, 可选, 默认为 2) — 序列结束词元的 ID。 - decoder_start_token_id (
int, 可选) — 该模型使用 `eos_token_id` 开始解码。 - encoder_layerdrop (
float, 可选, 默认为 0.0) — 请谷歌搜索 “layerdrop arxiv”，因为无法用一句话解释清楚。 - decoder_layerdrop (
float, 可选, 默认为 0.0) — 请谷歌搜索 “layerdrop arxiv”，因为无法用一句话解释清楚。 - is_encoder_decoder (
bool, 可选, 默认为True) — 这是否是一个编码器/解码器模型。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否绑定输入和输出嵌入。 - num_beams (
int, 可选, 默认为 5) — 用于束搜索的束数量，模型 `generate` 方法将默认使用此值。1 表示不使用束搜索。 - length_penalty (
float, 可选, 默认为 1) — 用于基于束的生成的长度指数惩罚。它作为序列长度的指数，然后用于除以序列的得分。由于得分是序列的对数似然（即负值），`length_penalty` > 0.0 会鼓励生成更长的序列，而 `length_penalty` < 0.0 会鼓励生成更短的序列。 - early_stopping (
bool, 可选, 默认为False) — 该标志将默认用于模型的 `generate` 方法。是否在每批次中至少有 `num_beams` 个句子完成时停止束搜索。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。 - forced_eos_token_id (
int, 可选, 默认为 2) — 当达到 `max_length` 时，强制作为最后一个生成词元的 ID。通常设置为 `eos_token_id`。
这是一个配置类，用于存储 FSMTModel 的配置。它用于根据指定的参数实例化一个 FSMT 模型，定义模型架构。使用默认值实例化配置将产生与 FSMT facebook/wmt19-en-ru 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import FSMTConfig, FSMTModel
>>> # Initializing a FSMT facebook/wmt19-en-ru style configuration
>>> config = FSMTConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = FSMTModel(config)
>>> # Accessing the model configuration
>>> configuration = model.configFSMTTokenizer
class transformers.FSMTTokenizer
< source >( langs = None src_vocab_file = None tgt_vocab_file = None merges_file = None do_lower_case = False unk_token = '<unk>' bos_token = '<s>' sep_token = '</s>' pad_token = '<pad>' **kwargs )
参数
- langs (
List[str], 可选) — 包含两种语言的列表，用于指定翻译的源语言和目标语言，例如["en", "ru"]。 - src_vocab_file (
str, 可选) — 包含源语言词汇表的文件。 - tgt_vocab_file (
st, 可选) — 包含目标语言词汇表的文件。 - merges_file (
str, 可选) — 包含合并规则的文件。 - do_lower_case (
bool, 可选, 默认为False) — 是否在分词时将输入转换为小写。 - unk_token (
str, 可选, 默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，将被设置为此词元。 - bos_token (
str, 可选, 默认为"<s>") — 序列开始词元，在预训练期间使用。可用作序列分类器的词元。当使用特殊词元构建序列时，这不是用于序列开始的词元。使用的词元是 `cls_token`。
- sep_token (
str, 可选, 默认为"</s>") — 分隔符词元，用于从多个序列构建一个序列时，例如，用于序列分类的两个序列，或用于问答任务的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的词元，例如在批处理不同长度的序列时使用。
构建一个 FAIRSEQ Transformer 分词器。基于字节对编码 (Byte-Pair Encoding)。分词过程如下：
- Moses 预处理和分词。
- 对所有输入文本进行归一化。
- 参数 `special_tokens` 和函数 `set_special_tokens` 可用于向词汇表添加额外的符号（如 “classify”）。
- 参数
langs定义了一对语言。
该分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
通过连接和添加特殊词元，为序列分类任务从一个序列或一对序列构建模型输入。FAIRSEQ Transformer 序列具有以下格式
- 单个序列：
<s> X </s> - 序列对：
<s> A </s> B </s>
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
创建与传入序列对应的标记类型 ID。什么是标记类型 ID？
如果模型有特殊的构建方式，应在子类中重写此方法。
FSMTModel
class transformers.FSMTModel
< source >( config: FSMTConfig )
参数
- config (FSMTConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
基础的 Fsmt 模型，输出原始的隐藏状态，顶部没有任何特定的头。
此模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: LongTensor attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[tuple[torch.FloatTensor]] = None past_key_values: typing.Optional[tuple[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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()。
FSMT 使用 `eos_token_id` 作为生成 `decoder_input_ids` 的起始词元。如果使用 `past_key_values`，可以选择只输入最后的 `decoder_input_ids`（参见 `past_key_values`）。
- decoder_attention_mask (
torch.BoolTensor, 形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略 `decoder_input_ids` 中填充词元的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor, 形状为(num_heads,)或(num_layers, num_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[torch.FloatTensor], 可选) — 元组包含（`last_hidden_state`，可选：`hidden_states`，可选：`attentions`）。形状为 `(batch_size, sequence_length, hidden_size)` 的 `last_hidden_state`，可选，是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
tuple[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在解码的前一个阶段，当 `use_cache=True` 或 `config.use_cache=True` 时，模型返回的 `past_key_values`。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元组，其中每个元组包含2个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 `past_key_values`，将返回传统缓存格式。
如果使用 `past_key_values`，用户可以选择只输入最后一个 `input_ids`（即那些没有为其提供过去键值状态的词元），形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- use_cache (
bool, 可选) — 如果设置为 `True`，将返回 `past_key_values` 键值状态，可用于加速解码（参见 `past_key_values`）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - 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`。
- return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 `torch.FloatTensor` 元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含根据配置（FSMTConfig）和输入而异的各种元素。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
EncoderDecoderCache, 可选, 在传递 `use_cache=True` 或 `config.use_cache=True` 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为 `(batch_size, sequence_length, hidden_size)`。解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为 `(batch_size, sequence_length, hidden_size)`。编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
FSMTModel 的 forward 方法，重写了 `__call__` 特殊方法。
尽管前向传播的逻辑需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会默默地忽略它们。
FSMTForConditionalGeneration
class transformers.FSMTForConditionalGeneration
< source >( config: FSMTConfig )
参数
- config (FSMTConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
带有语言模型头的 FSMT 模型。可用于摘要生成。
此模型继承自 PreTrainedModel。请查阅超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[tuple[torch.FloatTensor]] = None past_key_values: typing.Optional[tuple[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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()。
FSMT 使用 `eos_token_id` 作为生成 `decoder_input_ids` 的起始词元。如果使用 `past_key_values`，可以选择只输入最后的 `decoder_input_ids`（参见 `past_key_values`）。
- decoder_attention_mask (
torch.BoolTensor, 形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略 `decoder_input_ids` 中填充词元的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_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[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
tuple[torch.FloatTensor]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含在解码的前一阶段，当use_cache=True或config.use_cache=True时，模型返回的past_key_values。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后的input_ids（那些没有为其提供过去键值状态的 ID），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为相关联的向量，这会很有用。 - decoder_inputs_embeds (
torch.Tensor，形状为(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的值。 - 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）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（FSMTConfig）和输入，包含各种元素。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
EncoderDecoderCache, 可选, 在传递 `use_cache=True` 或 `config.use_cache=True` 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为 `(batch_size, sequence_length, hidden_size)`。解码器在每一层输出时的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出），形状为 `(batch_size, sequence_length, hidden_size)`。编码器在每一层输出时的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), 可选, 在传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
FSMTForConditionalGeneration 的 forward 方法会覆盖 __call__ 特殊方法。
尽管前向传播的逻辑需要在此函数内定义，但之后应该调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会默默地忽略它们。
翻译示例
>>> from transformers import AutoTokenizer, FSMTForConditionalGeneration
>>> mname = "facebook/wmt19-ru-en"
>>> model = FSMTForConditionalGeneration.from_pretrained(mname)
>>> tokenizer = AutoTokenizer.from_pretrained(mname)
>>> src_text = "Машинное обучение - это здорово, не так ли?"
>>> input_ids = tokenizer(src_text, return_tensors="pt").input_ids
>>> outputs = model.generate(input_ids, num_beams=5, num_return_sequences=3)
>>> tokenizer.decode(outputs[0], skip_special_tokens=True)
"Machine learning is great, isn't it?"