Hugging Face 的标志

Transformers 文档

FSMT

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

FSMT

概述

FSMT (FairSeq MachineTranslation) 模型在 Facebook FAIR 的 WMT19 新闻翻译任务提交中被 Nathan Ng、Kyra Yee、Alexei Baevski、Myle Ott、Michael Auli、Sergey Edunov 提出。

该论文的摘要如下：

本文介绍了 Facebook FAIR 提交给 WMT19 共享新闻翻译任务的内容。我们参与了两个语言对和四个语言方向：英语 <-> 德语和英语 <-> 俄语。延续我们去年的提交，我们的基线系统是基于 BPE 的大型 transformer 模型，这些模型使用 Fairseq 序列建模工具包进行训练，并依赖于采样的反向翻译。今年，我们尝试了不同的双语文本数据过滤方案，以及添加过滤后的反向翻译数据。我们还在特定领域的数据上集成和微调了我们的模型，然后使用噪声信道模型重排序进行解码。在人工评估活动的所有四个方向中，我们的提交均排名第一。在英 -> 德方向，我们的系统显著优于其他系统以及人工翻译。该系统比我们 WMT’18 的提交提高了 4.5 BLEU 分。

此模型由 stas 贡献。原始代码可以在这里找到。

实现说明

  • FSMT 使用未组合成一个的源词汇和目标词汇对。它也不共享嵌入 tokens。它的分词器与 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) — 编码器的词汇表大小。定义了可以由传递给编码器中 forward 方法的 inputs_ids 表示的不同 token 的数量。
  • tgt_vocab_size (int) — 解码器的词汇表大小。定义了可以由传递给解码器中 forward 方法的 inputs_ids 表示的不同 token 的数量。
  • d_model (int, optional, defaults to 1024) — 层和池化器层的维度。
  • encoder_layers (int, optional, defaults to 12) — 编码器层数。
  • decoder_layers (int, optional, defaults to 12) — 解码器层数。
  • encoder_attention_heads (int, optional, defaults to 16) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_attention_heads (int, optional, defaults to 16) — Transformer 解码器中每个注意力层的注意力头数。
  • decoder_ffn_dim (int, optional, defaults to 4096) — 解码器中“中间”（通常称为前馈）层的维度。
  • encoder_ffn_dim (int, optional, defaults to 4096) — 解码器中“中间”（通常称为前馈）层的维度。
  • activation_function (str 或 Callable, optional, defaults to "relu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu", "relu", "silu" 和 "gelu_new"。
  • dropout (float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。
  • activation_dropout (float, optional, defaults to 0.0) — 全连接层内部激活的 dropout 比率。
  • max_position_embeddings (int, optional, defaults to 1024) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
  • init_std (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • scale_embedding (bool, optional, defaults to True) — 是否通过除以 sqrt(d_model) 来缩放嵌入。
  • bos_token_id (int, optional, defaults to 0) — 流开始 token id。
  • pad_token_id (int, optional, defaults to 1) — 填充 token id。
  • eos_token_id (int, optional, defaults to 2) — 流结束 token id。
  • decoder_start_token_id (int, optional) — 此模型以 eos_token_id 开始解码
  • encoder_layerdrop (float, optional, defaults to 0.0) — 谷歌 “layerdrop arxiv”，因为它无法用一句话解释清楚。
  • decoder_layerdrop (float, optional, defaults to 0.0) — 谷歌 “layerdrop arxiv”，因为它无法用一句话解释清楚。
  • is_encoder_decoder (bool, optional, defaults to True) — 是否为编码器/解码器模型。
  • tie_word_embeddings (bool, optional, defaults to False) — 是否绑定输入和输出嵌入。
  • num_beams (int, optional, defaults to 5) — beam search 的 beam 数量，默认情况下将在模型的 generate 方法中使用。1 表示不使用 beam search。
  • length_penalty (float, optional, defaults to 1) — 用于基于 beam 的生成的指数长度惩罚。它作为序列长度的指数应用，而序列长度又用于除以序列的分数。由于分数是序列的对数似然（即负数），因此 length_penalty > 0.0 会促进更长的序列，而 length_penalty < 0.0 会鼓励更短的序列。
  • early_stopping (bool, optional, defaults to False) — 一个标志，默认情况下将在模型的 generate 方法中使用。指示是否在每个批次至少完成 num_beams 个句子时停止 beam search。
  • use_cache (bool, optional, defaults to True) — 模型是否应返回最后一次的键/值注意力机制（并非所有模型都使用）。
  • forced_eos_token_id (int, optional, defaults to 2) — 当达到 max_length 时，强制作为最后一个生成的 token 的 token 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.config

FSMTTokenizer

class transformers.FSMTTokenizer

< >

( 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], optional) — 要翻译的源语言和目标语言的列表，例如 ["en", "ru"]。
  • src_vocab_file (str, optional) — 包含源语言词汇表的文件。
  • tgt_vocab_file (st, optional) — 包含目标语言词汇表的文件。
  • merges_file (str, optional) — 包含 merges 的文件。
  • do_lower_case (bool, optional, defaults to False) — 是否在 tokenizing 时将输入转换为小写。
  • unk_token (str, optional, defaults to "<unk>") — 未知 token。词汇表中没有的 token 无法转换为 ID，而是设置为此 token。
  • bos_token (str, optional, defaults to "<s>") — 预训练期间使用的序列开始 token。可以用作序列分类器 token。

    当使用特殊 token 构建序列时，这不是用于序列开头的 token。使用的 token 是 cls_token。
  • sep_token (str, optional, defaults to "</s>") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。
  • pad_token (str, optional, defaults to "<pad>") — 用于 padding 的 token，例如在对不同长度的序列进行批处理时。

构建 FAIRSEQ Transformer tokenizer。基于 Byte-Pair Encoding。tokenization 过程如下：

  • Moses 预处理和 tokenization。
  • 规范化所有输入文本。
  • 参数 special_tokens 和函数 set_special_tokens 可用于向词汇表添加其他符号（如“classify”）。
  • 参数 langs 定义了一对语言。

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

build_inputs_with_special_tokens

< >

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

参数

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

返回值

List[int]

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

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

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

get_special_tokens_mask

< >

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

参数

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

返回值

List[int]

范围在 [0, 1] 内的整数列表：1 表示特殊令牌，0 表示序列令牌。

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回值

List[int]

根据给定的序列的 令牌类型 ID 列表。

从传递的两个序列创建掩码，用于序列对分类任务。FAIRSEQ

Transformer 序列对掩码具有以下格式

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。

从传递的两个序列创建掩码，用于序列对分类任务。FAIRSEQ_TRANSFORMER 序列对掩码具有以下格式

save_vocabulary

< >

( save_directory: str filename_prefix: typing.Optional[str] = None )

FSMTModel

class transformers.FSMTModel

< >

( config: FSMTConfig )

参数

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

裸 FSMT 模型，输出原始隐藏状态，顶部没有任何特定的头。

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

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

forward

< >

( 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[typing.Tuple[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.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 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列令牌的索引。

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

    什么是输入 ID？

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

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

    什么是注意力掩码？

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

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

    什么是解码器输入 ID？

    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), optional) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的填充令牌。默认情况下，也将使用因果掩码。
  • head_mask (torch.Tensor，形状为 (encoder_layers, encoder_attention_heads), optional) — 用于使编码器中注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值：

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

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

    • 1 表示头未被掩盖，
    • 0 表示头被掩盖。
  • encoder_outputs (Tuple(torch.FloatTensor), optional) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。 last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，是编码器最后一层的输出处的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (Tuple(torch.FloatTensor)，长度为 config.n_layers，每个元组有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • decoder_inputs_embeds (torch.FloatTensor，形状为 (batch_size, target_sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_ids。如果使用 past_key_values，则可以选择仅输入最后的 decoder_inputs_embeds（请参阅 past_key_values）。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 decoder_input_ids 索引转换为关联的向量，这将非常有用。

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

  • use_cache (bool, optional, defaults to True) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回 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 (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 元组（如果模型有嵌入层，则为嵌入的输出，加上每层输出一个），形状为 (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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选的) — 模型编码器最后一层输出端的隐藏状态序列。

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

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

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

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

The FSMTModel forward 方法，重写了 __call__ 特殊方法。

尽管前向传播的步骤需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责处理预处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FSMTModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wmt19-ru-en")
>>> model = FSMTModel.from_pretrained("facebook/wmt19-ru-en")

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

>>> last_hidden_states = outputs.last_hidden_state

FSMTForConditionalGeneration

class transformers.FSMTForConditionalGeneration

< >

( config: FSMTConfig )

参数

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

带有语言建模头的 FSMT 模型。可用于摘要。

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

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

forward

< >

( 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[typing.Tuple[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.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 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

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

    • 1 表示 tokens 未被屏蔽，
    • 0 表示 tokens 已被屏蔽。

    什么是注意力 masks？

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

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

    什么是解码器输入 IDs？

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

  • decoder_attention_mask (形状为 (batch_size, target_sequence_length) 的 torch.BoolTensor, 可选的) — 默认行为：生成一个忽略 decoder_input_ids 中的 pad tokens 的张量。默认情况下，也将使用因果 mask。
  • head_mask (形状为 (encoder_layers, encoder_attention_heads) 的 torch.Tensor, 可选的) — 用于 nullify 编码器中注意力模块的选定 heads 的 Mask。Mask 值在 [0, 1] 中选择：

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

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

    • 1 表示 head 未被屏蔽，
    • 0 表示 head 已被屏蔽。
  • encoder_outputs (Tuple(torch.FloatTensor), 可选的) — 元组由 (last_hidden_state, 可选的: hidden_states, 可选的: attentions) 组成。形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state 是编码器最后一层输出端的隐藏状态序列。在解码器的交叉注意力中使用。
  • past_key_values (长度为 config.n_layers 的 Tuple(torch.FloatTensor)，其中每个元组有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力模块的预计算的键和值隐藏状态。可用于加速解码。如果使用 past_key_values，用户可以选择仅输入最后一个 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选的) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望更好地控制如何将 input_ids 索引转换为关联的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。
  • decoder_inputs_embeds (形状为 (batch_size, target_sequence_length, hidden_size) 的 torch.FloatTensor, 可选的) — 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_ids。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_inputs_embeds（参见 past_key_values）。如果您希望更好地控制如何将 decoder_input_ids 索引转换为关联的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。

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

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

返回值

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 (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测得分（SoftMax 之前的每个词汇 token 的得分）。

  • 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 元组（如果模型有嵌入层，则为嵌入的输出，加上每层输出一个），形状为 (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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选的) — 模型编码器最后一层输出端的隐藏状态序列。

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

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

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

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

The 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?"
< > 在 GitHub 上更新

←FNet Funnel Transformer→