Transformers 文档

FSMT

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始

FSMT

概述

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

该论文的摘要如下:

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

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

实现说明

  • 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) — 编码器的词汇量大小。定义了可以通过传递给编码器 forward 方法的 inputs_ids 表示的不同 token 的数量。
  • tgt_vocab_size (int) — 解码器的词汇量大小。定义了可以通过传递给解码器 forward 方法的 inputs_ids 表示的不同 token 的数量。
  • 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) — 解码器中“中间”(通常称为前馈)层的维度。
  • dropout (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比例。
  • activation_dropout (float, 可选, 默认为 0.0) — 全连接层内部激活值的 dropout 比例。
  • 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 开始解码。
  • decoder_layerdrop (float, optional, defaults to 0.0) — Google “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) — 模型 generate 方法中默认使用的集束搜索光束数量。1 表示没有集束搜索。
  • length_penalty (float, optional, defaults to 1) — 用于基于集束的生成的长度的指数惩罚。它被应用于序列长度的指数,然后用于除以序列的分数。由于分数是序列的对数似然(即负数),length_penalty > 0.0 促进更长的序列,而 length_penalty < 0.0 鼓励更短的序列。
  • early_stopping (bool, optional, defaults to False) — 模型 generate 方法中默认使用的标志。是否在每个批次完成至少 num_beams 个句子时停止集束搜索。
  • use_cache (bool, optional, defaults to True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。
  • forced_eos_token_id (int, optional, defaults to 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.config

FSMTTokenizer

class transformers.FSMTTokenizer

< >

( langs = None

参数

  • langs (List[str], optional) — 例如 ["en", "ru"],用于指定要进行翻译的两种语言。
  • src_vocab_file (str, optional) — 包含源语言词汇的文件。
  • tgt_vocab_file (st, optional) — 包含目标语言词汇的文件。
  • merges_file (str, optional) — 包含合并操作的文件。
  • do_lower_case (bool, optional, defaults to False) — 是否在分词时将输入转换为小写。
  • unk_token (str, optional, defaults to "<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID,而是设置为此标记。
  • bos_token (str, optional, defaults to "<s>") — 预训练过程中使用的序列开始标记。可用作序列分类标记。

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

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

构建一个 FAIRSEQ Transformer 分词器。基于字节对编码。分词过程如下:

  • Moses 预处理和分词。
  • 规范化所有输入文本。
  • special_tokens 参数和 set_special_tokens 函数可以用于向词汇表添加额外的符号(如 ”classify”)。
  • langs 参数定义一对语言。

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

build_inputs_with_special_tokens

< >

( token_ids_0

参数

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

返回值

List[int]

带有相应特殊标记的 输入 ID 列表。

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

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

get_special_tokens_mask

< >

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

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可选) — 用于序列对的可选第二个 ID 列表。
  • already_has_special_tokens (bool, 可选, 默认为 False) — 令牌列表是否已使用模型的特殊标记进行格式化。

返回值

List[int]

范围在 [0, 1] 之内的整数列表:特殊标记为 1,序列标记为 0。

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

create_token_type_ids_from_sequences

< >

( token_ids_0

参数

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

返回值

List[int]

根据给定序列(s) 的 令牌类型 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_1None,则此方法仅返回掩码的第一部分(0)。

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

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = 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: 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 use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

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

    什么是输入 ID?

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

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

    什么是注意力掩码?

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

    可以使用 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)可选) — 默认行为:生成忽略 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(torch.FloatTensor)可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (长度为 config.n_layersTuple(torch.FloatTensor),每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用 past_key_values,则用户可以选择仅输入最后一个 decoder_input_ids(那些没有向此模型提供过去键值状态的 decoder_input_ids),形状为 (batch_size, 1),而不是所有 decoder_input_ids,形状为 (batch_size, sequence_length)
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为相关向量比模型的内部嵌入查找矩阵有更多控制,这很有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 decoder_input_ids。如果使用 past_key_values,则可以选择仅输入最后一个 decoder_inputs_embeds(请参阅 past_key_values)。如果您希望对如何将 decoder_input_ids 索引转换为相关向量比模型的内部嵌入查找矩阵有更多控制,这很有用。

    如果 decoder_input_idsdecoder_inputs_embeds 都未设置,则 decoder_inputs_embeds 将采用 inputs_embeds 的值。

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

返回值

transformers.modeling_outputs.Seq2SeqModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

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

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

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

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

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型具有嵌入层,再加上每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

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

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

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

The FSMTModel 正向方法,覆盖了 __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: LongTensor 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.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID?

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

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

    什么是注意力掩码?

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

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

    什么是解码器输入 ID?

    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 形状为 (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(torch.FloatTensor), 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: 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(其 past key value 状态未提供给此模型) 形状为 (batch_size, 1),而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。 如果你想比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多控制权,这很有用。
  • decoder_inputs_embeds (torch.FloatTensor 形状为 (batch_size, target_sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 decoder_input_ids。 如果使用 past_key_values,可以选择性地仅输入最后一个 decoder_inputs_embeds(参见 past_key_values)。 如果 decoder_input_idsdecoder_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, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。 索引应在 [0, ..., config.vocab_size] 或 -100 中(参见 input_ids 文档字符串)。 索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。

返回值

transformers.modeling_outputs.Seq2SeqLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.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 之前的每个词汇表标记的得分)。

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

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

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

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

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

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

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型具有嵌入层,再加上每个层的输出)形状为 (batch_size, sequence_length, hidden_size)

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

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

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

FSMTForConditionalGeneration 正向方法覆盖 __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 上更新