M2M100
概述
M2M100模型由Angel Fan、Shruti Bhosale、Holger Schwenk、Zhiyi Ma、Ahmed El-Kishky、Siddharth Goyal、Mandeep Baines、Onur Celebi、Guillaume Wenzek、Vishrav Chaudhary、Naman Goyal、Tom Birch、Vitaliy Liptchinsky、Sergey Edunov、Edouard Grave、Michael Auli和Armand Joulin在《超越以英语为中心的多语言机器翻译》一文中提出，该文发表于arXiv。
论文的摘要如下：
现有的翻译研究通过训练一个能够翻译任何一对语言的单一模型，展示了大规模多语言机器翻译的潜力。然而，大多数工作都是基于英语的，因为它们仅使用从英语翻译而来或到英语翻译的数据进行训练。虽然这得到了大量训练数据的支持，但并不反映全世界的翻译需求。在这项工作中，我们创建了一个真正的多对多多语言翻译模型，它可以直接翻译任意一对100种语言的任意一对。我们构建了一个开源的训练数据集，覆盖了成千上万的语言方向，包括经过大规模挖掘生成的监督数据。然后，我们探讨了如何通过结合密集扩展和特定语言的稀疏参数来有效地提高模型容量，以创建高质量的模型。我们关注非英语为中心的模型得益于在直接翻译非英语方向时，比WMT中最好的单一系统获得了超过10 BLEU的收益。我们开源了我们的脚本，以便其他人可以重现数据和评估，以及最终的M2M-100模型。
此模型由valhalla贡献。
使用技巧和示例
M2M100是一个多语言编码器-解码器（seq-to-seq）模型，主要用于翻译任务。由于该模型是多语言的，因此它期望输入的序列遵循一定格式：在源文和目标文中都使用特殊语言ID标记作为前缀。源文格式为[lang_code] X [eos]，其中lang_code是源文语言ID（对于源文）和目标文语言ID（对于目标文），X为源文或目标文。
M2M100Tokenizer依赖于sentencepiece，因此在运行示例之前请确保已安装。安装sentencepiece的命令是：pip install sentencepiece。
监督训练
from transformers import M2M100Config, M2M100ForConditionalGeneration, M2M100Tokenizer
model = M2M100ForConditionalGeneration.from_pretrained("facebook/m2m100_418M")
tokenizer = M2M100Tokenizer.from_pretrained("facebook/m2m100_418M", src_lang="en", tgt_lang="fr")
src_text = "Life is like a box of chocolates."
tgt_text = "La vie est comme une boîte de chocolat."
model_inputs = tokenizer(src_text, text_target=tgt_text, return_tensors="pt")
loss = model(**model_inputs).loss # forward pass生成
M2M100使用eos_token_id作为生成时的decoder_start_token_id，并强制目标语言ID作为第一个生成的标记。要强制目标语言ID作为第一个生成的标记，在调用generate方法时传递forced_bos_token_id参数。以下示例展示了如何使用facebook/m2m100_418M检查点将印地语翻译成法语和中文翻译成英语：
>>> from transformers import M2M100ForConditionalGeneration, M2M100Tokenizer
>>> hi_text = "जीवन एक चॉकलेट बॉक्स की तरह है।"
>>> chinese_text = "生活就像一盒巧克力。"
>>> model = M2M100ForConditionalGeneration.from_pretrained("facebook/m2m100_418M")
>>> tokenizer = M2M100Tokenizer.from_pretrained("facebook/m2m100_418M")
>>> # translate Hindi to French
>>> tokenizer.src_lang = "hi"
>>> encoded_hi = tokenizer(hi_text, return_tensors="pt")
>>> generated_tokens = model.generate(**encoded_hi, forced_bos_token_id=tokenizer.get_lang_id("fr"))
>>> tokenizer.batch_decode(generated_tokens, skip_special_tokens=True)
"La vie est comme une boîte de chocolat."
>>> # translate Chinese to English
>>> tokenizer.src_lang = "zh"
>>> encoded_zh = tokenizer(chinese_text, return_tensors="pt")
>>> generated_tokens = model.generate(**encoded_zh, forced_bos_token_id=tokenizer.get_lang_id("en"))
>>> tokenizer.batch_decode(generated_tokens, skip_special_tokens=True)
"Life is like a box of chocolate."资源
M2M100Config
类 transformers.M2M100Config
< 源 >( vocab_size = 128112 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.05 decoder_layerdrop = 0.05 use_cache = True is_encoder_decoder = True activation_function = 'relu' d_model = 1024 dropout = 0.1 attention_dropout = 0.1 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 2 scale_embedding = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认值为 50265) — M2M100模型的词汇量。定义了在调用M2M100Model时可以通过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或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) — 所有权重矩阵初始化的截断正态分布的标准差。 -
float, 可选, 默认为0.0) — 编码器的LayerDrop概率。有关更多详细信息，请参阅[LayerDrop论文](查阅https://arxiv.org/abs/1909.11556)。--— - decoder_layerdrop （
float，可选择，默认为 0.0） —— 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556**)。 - use_cache （
bool，可选择，默认为True） —— 模型是否应该返回最后的键/值注意力（不是所有模型都使用）。
这是存储 M2M100Model 配置的配置类。它用于根据指定参数实例化一个 M2M100 模型，定义模型架构。使用默认值实例化配置将产生与 M2M100 facebook/m2m100_418M 架构相似的配置。
配置对象继承自 PretrainedConfig 并可用于控制模型输出。有关更多详细信息，请参阅 [PretrainedConfig](/docs/transformers/v4.44.0/en/main_classes/configuration#transformers.PretrainedConfig) 文档。
示例
>>> from transformers import M2M100Config, M2M100Model
>>> # Initializing a M2M100 facebook/m2m100_418M style configuration
>>> configuration = M2M100Config()
>>> # Initializing a model (with random weights) from the facebook/m2m100_418M style configuration
>>> model = M2M100Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configM2M100Tokenizer
class transformers.M2M100Tokenizer
< source >( vocab_file spm_file src_lang = None tgt_lang = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' pad_token = '<pad>' unk_token = '<unk>' language_codes = 'm2m100' sp_model_kwargs: Optional = None num_madeup_words = 8 **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - spm_file (
str) — 存储词汇的 SentencePiece 文件路径（通常具有 .spm 扩展名）。 - src_lang (
str, 可选) — 表示源语言的字符串。 - tgt_lang (
str, 可选) — 表示目标语言的字符串。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，用于将多个序列构建成一个序列时，如序列分类或用于问答的文本和问题，它也被用作带特殊标记构建的序列的最后标记。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。如果标记不在词汇表中，则不能转换为ID，而是将此标记设置为默认值。 - pad_token (
str, 可选, 默认为"<pad>") — 填充标记，用于填充不同长度的序列，例如批处理序列时。 - language_codes (
str, 可选, 默认为"m2m100") — 使用哪种语言代码。可以是"m2m100"或"wmt21"。 - sp_model_kwargs (
dict, 可选) — 将传递给SentencePieceProcessor.__init__()方法。Python 的 SentencePiece 包装器可以用来设置：enable_sampling: 启用子词正则化。nbest_size: 用于一元组的采样参数。对 BPE-Dropout 无效。nbest_size = {0,1}: 不进行采样。nbest_size > 1: 从 nbest_size 个结果中采样。nbest_size < 0: 假设 nbest_size 是无限的，使用 forward-filtering-and-backward-sampling 算法从所有假设（lattice）中采样。
alpha: 用于一元组采样的平滑参数，以及 BPE-dropout 的合并操作的 dropout 概率。
创建 M2M100 分词器。基于 SentencePiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此基类获取有关这些方法的更多信息。
示例
>>> from transformers import M2M100ForConditionalGeneration, M2M100Tokenizer
>>> model = M2M100ForConditionalGeneration.from_pretrained("facebook/m2m100_418M")
>>> tokenizer = M2M100Tokenizer.from_pretrained("facebook/m2m100_418M", src_lang="en", tgt_lang="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")
>>> outputs = model(**model_inputs) # should workbuild_inputs_with_special_tokens
参数
返回
列表[int]
带有适当特殊标记的输入ID的列表。
通过连接和添加特殊标记，从序列或序列对构建模型输入，用于序列分类任务。MBART 序列的格式如下，其中 X 代表序列：
input_ids（对于编码器）X [eos, src_lang_code]decoder_input_ids：（对于解码器）X [eos, tgt_lang_code]
不使用 BOS。序列对不是预期的使用场景，但将无分隔符处理。
get_special_tokens_mask
< 来源 >( token_ids_0: 列表 token_ids_1: 可选 = None already_has_special_tokens: 布尔 = False ) → 列表[int]
从未添加特殊token的token列表中检索序列ID。该方法在使用tokenizer的prepare_for_model方法添加特殊token时调用。
create_token_type_ids_from_sequences
< source >创建与传入的序列相对应的标记类型ID。 什么是标记类型ID？
如果模型有特殊的构建这些ID的方法，则应在子类中重写。
M2M100Model
类 transformers.M2M100Model
< 来源 >( 配置: M2M100配置 )
参数
- 配置 （M2M100配置） — 包含所有模型参数的配置类。使用配置文件初始化时不会加载与模型相关联的权重，只有配置。请查看from_pretrained()方法以加载模型权重。
一个M2M100模型，输出原始隐藏状态，没有在顶部添加任何特定的头部。该模型继承自PreTrainedModel。请参阅超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
该模型也是PyTorch torch.nn.Module子类。将其用作常规PyTorch模块，并参阅PyTorch文档以获取有关通用使用和行为的所有问题。
forward
< 源代码 >( input_ids: 可选 = None attention_mask: 可选 = None decoder_input_ids: 可选 = None decoder_attention_mask: 可选 = None head_mask: 可选 = None decoder_head_mask: 可选 = None cross_attn_head_mask: 可选 = None encoder_outputs: 可选 = None past_key_values: 可选 = None inputs_embeds: 可选 = None decoder_inputs_embeds: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.Seq2SeqModelOutput 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()。
M2M100 使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则可以选填只输入最后的decoder_input_ids（见past_key_values）。 - decoder_attention_mask (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个 Tensor，忽略decoder_input_ids中的填充标记。默认也会使用因果掩码。 -
(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(tuple(torch.FloatTensor))的元组，每个子元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及2个附加形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。 包含预先计算的自注意力块和交叉注意力块中的隐藏状态（键和值），可用于快速顺序解码（请参阅past_key_values输入）。 如果使用past_key_values，用户可以选择只输入最后一个decoder_input_ids（那些没有向此模型提供其过去键值状态的）的形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds （形状为
torch.FloatTensor的(batch_size, sequence_length, hidden_size)的张量，可选）— 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。这在您需要在将input_ids索引转换为其相关向量方面比模型内部的嵌入查找矩阵有更多控制权时很有用。 - decoder_inputs_embeds (
torch.FloatTensorof shape(batch_size, target_sequence_length, hidden_size), optional) — 可以选择直接传递嵌入表示，而不传递decoder_input_ids。如果使用past_key_values，则只需输入最后decoder_inputs_embeds。这在需要对decoder_input_ids索引转换为相关向量有更多控制时很有用，比模型内部嵌入查找矩阵更灵活。如果 both
decoder_input_idsanddecoder_inputs_embeds都未设置，decoder_inputs_embeds将取inputs_embeds的值。 - use_cache (
bool, optional) — 如果设置为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）。
-
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))，optional，在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)，optional，在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时返回）— 每个层都有一个形式为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器注意力权重的softmax后，用于计算自注意力头中的加权平均。
-
cross_attentions （
tuple(torch.FloatTensor)，可选的，当传递output_attentions=True或config.output_attentions=True时返回）— 每个层都有一个形式为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器交叉注意力层的注意力权重视软 Emit后，用于计算交叉注意力头中的加权平均。
-
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时返回）— 如果模型有嵌入层，则包含嵌入输出的形状为(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后，用于计算自注意力头中的加权平均。
M2M100Model 的前进方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数内定义前向传递的配方，但应该调用 Module 实例而不是此函数，因为前者处理预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, M2M100Model
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/m2m100_418M")
>>> model = M2M100Model.from_pretrained("facebook/m2m100_418M")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateM2M100ForConditionalGeneration
class transformers.M2M100ForConditionalGeneration
< source >( 配置: M2M100配置 )
参数
- config (M2M100Config) — 模型配置类，包含所有模型参数。使用配置文件初始化不加载模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
M2M100模型，包含语言建模头。可用于总结。此模型继承自PreTrainedModel。检查父类文档，了解库为所有模型实现的通用方法（如下载或保存，调整输入嵌入大小，剪枝头部等。）
该模型也是PyTorch torch.nn.Module子类。将其用作常规PyTorch模块，并参阅PyTorch文档以获取有关通用使用和行为的所有问题。
forward
< source >( input_ids: 可选 = Noneattention_mask: 可选 = Nonedecoder_input_ids: 可选 = Nonedecoder_attention_mask: 可选 = Nonehead_mask: 可选 = Nonedecoder_head_mask: 可选 = Nonecross_attn_head_mask: 可选 = Noneencoder_outputs: 可选 = Nonepast_key_values: 可选 = Noneinputs_embeds: 可选 = Nonedecoder_inputs_embeds: 可选 = Nonelabels: 可选 = Noneuse_cache: 可选 = Noneoutput_attentions: 可选 = Noneoutput_hidden_states: 可选 = Nonereturn_dict: 可选 = None ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列token在词汇表中的索引。如果提供，将默认忽略填充。索引可以通过使用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()。
M2M100 使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则可以可选地只输入最后的decoder_input_ids（详见past_key_values）。 - 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.Tensorof shape(编码层, 解码注意力头), 可选) — 用于取消解码器中交叉注意力模块选定的头的掩码。掩码值在[0, 1]之间:- 1表示该头未进行掩码,
- 0表示该头已进行掩码。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — 由 (最后隐藏状态, 可选：隐藏状态, 可选：注意力) 组成的元组，其中最后隐藏状态的形状为(批量大小, 序列长度, 隐藏大小)，可选) 是编码器最后一层的隐藏状态序列。用于解码器的交叉注意力中。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))，其中每个 tuple 包含两个形状为(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，用户可以选择只输入最后的decoder_input_ids（那些没有提供给我这个模型的过去键值状态的）的形状为(batch_size, 1)，而不是所有decoder_input_ids的形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), 可选) — 可选，您可以直接传递嵌入表示，而不是传递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类型） — 如果设置为True，past_key_values密钥值状态将被返回，并且可以用于加速解码（参见past_key_values）。 - output_attentions （可选参数，
bool类型） — 是否返回所有注意力层的注意力张量。更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。请参见返回张量中的hidden_states以获取更多详细信息。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensorof shape(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），包含基于配置（M2M100Config）和输入的各种元素。
-
loss (
torch.FloatTensorof shape(1,), 可选，当提供labels时返回) — 语言建模损失。 -
logits (
torch.FloatTensor的形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测得分（SoftMax 之前每个词汇项的得分）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，optional，在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)，optional，在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时返回）— 每个层都有一个形式为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器注意力权重的softmax后，用于计算自注意力头中的加权平均。
-
cross_attentions （
tuple(torch.FloatTensor)，可选的，当传递output_attentions=True或config.output_attentions=True时返回）— 每个层都有一个形式为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组。解码器交叉注意力层的注意力权重视软 Emit后，用于计算交叉注意力头中的加权平均。
-
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时返回）— 如果模型有嵌入层，则包含嵌入输出的形状为(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后，用于计算自注意力头中的加权平均。
M2M100ForConditionalGeneration 的 forward 方法覆盖了 __call__ 特殊方法。
尽管需要在此函数内定义前向传递的配方，但应该调用 Module 实例而不是此函数，因为前者处理预和后处理步骤，而后者则默默地忽略它们。
翻译示例
>>> from transformers import AutoTokenizer, M2M100ForConditionalGeneration
>>> model = M2M100ForConditionalGeneration.from_pretrained("facebook/m2m100_418M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/m2m100_418M")
>>> text_to_translate = "Life is like a box of chocolates"
>>> model_inputs = tokenizer(text_to_translate, return_tensors="pt")
>>> # translate to French
>>> gen_tokens = model.generate(**model_inputs, forced_bos_token_id=tokenizer.get_lang_id("fr"))
>>> print(tokenizer.batch_decode(gen_tokens, skip_special_tokens=True))使用 Flash Attention 2
Flash Attention 2 是一种更快的、优化的注意力得分计算版本，依赖于 cuda 内核。
安装
首先，检查您的硬件是否与 Flash Attention 2 兼容。兼容硬件的最新列表可以在 官方文档 中找到。
接下来，安装 Flash Attention 2 的最新版本
pip install -U flash-attn --no-build-isolation
用法
要使用 Flash Attention 2 加载模型，我们可以向 .from_pretrained 传入参数 attn_implementation="flash_attention_2"。您可以使用 torch.float16 或 torch.bfloat16 精度。
>>> import torch
>>> from transformers import M2M100ForConditionalGeneration, M2M100Tokenizer
>>> model = M2M100ForConditionalGeneration.from_pretrained("facebook/m2m100_418M", torch_dtype=torch.float16, attn_implementation="flash_attention_2").to("cuda").eval()
>>> tokenizer = M2M100Tokenizer.from_pretrained("facebook/m2m100_418M")
>>> # translate Hindi to French
>>> hi_text = "जीवन एक चॉकलेट बॉक्स की तरह है।"
>>> tokenizer.src_lang = "hi"
>>> encoded_hi = tokenizer(hi_text, return_tensors="pt").to("cuda")
>>> generated_tokens = model.generate(**encoded_hi, forced_bos_token_id=tokenizer.get_lang_id("fr"))
>>> tokenizer.batch_decode(generated_tokens, skip_special_tokens=True)
"La vie est comme une boîte de chocolat."预期的加速
以下是预期加速图，比较原生实现和Flash Attention 2之间的纯推理时间。
