M2M100
原始文本：
huggingface.co/docs/transformers/v4.37.2/en/model_doc/m2m_100
概述
M2M100 模型是由 Angela 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 在 Beyond English-Centric Multilingual Machine Translation 中提出的。
该论文的摘要如下：
翻译领域的现有工作展示了通过训练单个模型能够在任意语言对之间进行翻译的巨大多语言机器翻译的潜力。然而，许多工作都是以英语为中心的，只在已经从英语翻译或翻译到英语的数据上进行训练。虽然这得到了大量的训练数据支持，但并不反映全球的翻译需求。在这项工作中，我们创建了一个真正的多对多多语言翻译模型，可以直接在任意一对 100 种语言之间进行翻译。我们构建并开源了一个训练数据集，涵盖了数千种语言方向的有监督数据，通过大规模挖掘创建。然后，我们探索如何通过密集缩放和特定语言的稀疏参数的组合有效地增加模型容量，以创建高质量的模型。我们专注于非英语为中心的模型，在直接翻译非英语方向时获得了超过 10 个 BLEU 的增益，同时在 WMT 最佳单一系统的竞争中表现出色。我们开源我们的脚本，以便其他人可以重现数据、评估和最终的 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 作为第一个生成的标记，请将 forced_bos_token_id 参数传递给 generate 方法。以下示例展示了如何使用 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
class 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 时可以表示的不同标记数量。d_model（int，可选，默认为 1024）— 层和池化层的维度。encoder_layers（int，可选，默认为 12）— 编码器层数。decoder_layers（int，可选，默认为 12）— 解码器层数。encoder_attention_heads（int，可选，默认为 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(strorfunction, optional, defaults to"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持"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 比率。classifier_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) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。encoder_layerdrop(float, optional, defaults to 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅LayerDrop 论文。decoder_layerdrop(float, optional, defaults to 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅LayerDrop 论文。use_cache(bool, optional, defaults toTrue) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。
这是用于存储 M2M100Model 配置的配置类。根据指定的参数实例化一个 M2M100 模型，定义模型架构。使用默认值实例化配置将产生类似于M2M100架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 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.config
M2M100Tokenizer
class transformers.M2M100Tokenizer
( 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, optional) — 表示源语言的字符串。tgt_lang(str, optional) — 表示目标语言的字符串。eos_token(str, optional, defaults to"") — 序列结束标记。sep_token(str, optional, defaults to"") — 分隔符标记，在构建多个序列的序列时使用，例如用于序列分类的两个序列或用于问题回答的文本和问题。它还用作使用特殊标记构建的序列的最后一个标记。unk_token(str, 可选, 默认为"") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。pad_token(str, 可选, 默认为"") — 用于填充的标记，例如在批处理不同长度的序列时使用。language_codes(str, 可选, 默认为"m2m100") — 要使用的语言代码。应为"m2m100"或"wmt21"之一。sp_model_kwargs(dict, 可选) — 将传递给SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 包装器可用于设置：
enable_sampling: 启用子词正则化。nbest_size: 用于 unigram 的抽样参数。对于 BPE-Dropout 无效。
nbest_size = {0,1}: 不执行抽样。nbest_size > 1: 从 nbest_size 结果中抽样。nbest_size < 0: 假设 nbest_size 是无限的，并使用前向过滤和后向抽样算法从所有假设（格子）中抽样。
alpha: unigram 抽样的平滑参数，以及 BPE-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 work
build_inputs_with_special_tokens
( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]
参数
token_ids_0(List[int]) — 将添加特殊标记的 ID 列表。token_ids_1(List[int], 可选) — 序列对的可选第二个 ID 列表。
返回
List[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: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → export const metadata = 'undefined';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: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]
参数
token_ids_0(List[int]) — 第一个标记化序列。token_ids_1(List[int], 可选) — 第二个标记化序列。
返回
List[int]
标记类型 ID。
创建与传递的序列相对应的标记类型 ID。什么是标记类型 ID？
如果模型有一种特殊的构建方式，则应在子类中重写此方法。
save_vocabulary
( save_directory: str filename_prefix: Optional = None )
M2M100Model
class transformers.M2M100Model
( config: M2M100Config )
参数
config(M2M100Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained()方法以加载模型权重。
裸的 M2M100 模型输出原始隐藏状态，没有特定的头部。此模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（如下载或保存、调整输入嵌入、修剪头部等）。
此模型还是一个 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。
forward
( input_ids: Optional = 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)
参数
input_ids(torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下，如果提供填充，则将忽略填充。
索引可以使用 AutoTokenizer 获得。查看 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？
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（形状为(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 用于使解码器中交叉注意力模块的选定头部失效的掩码。掩码值选定在[0, 1]中：
- 1 表示头部未被
masked， - 0 表示头部被
masked。
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输入）。
如果使用past_key_values，用户可以选择只输入最后一个形状为(batch_size, 1)的decoder_input_ids（那些没有将它们的过去键值状态提供给此模型的）而不是所有形状为(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，则返回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)
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个torch.FloatTensor元组（如果传递return_dict=False或当config.return_dict=False时），包括根据配置（M2M100Config）和输入的各种元素。
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层输出的一个 + 每层输出的一个）。
解码器在每一层输出的隐藏状态以及可选的初始嵌入输出。decoder_attentions(tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。cross_attentions(tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。encoder_last_hidden_state(torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，optional) — 模型编码器最后一层的隐藏状态序列。encoder_hidden_states(tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层输出的一个 + 每层输出的一个）。
编码器在每一层输出的隐藏状态以及可选的初始嵌入输出。encoder_attentions(tuple(torch.FloatTensor), optional, 当传递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_state
M2M100ForConditionalGeneration
class transformers.M2M100ForConditionalGeneration
( config: M2M100Config )
参数
config（M2M100Config）— 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
具有语言建模头部的 M2M100 模型。可用于摘要。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入、修剪头部等）。
此模型还是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。
forward
( input_ids: Optional = 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
input_ids（形状为(batch_size, sequence_length)的torch.LongTensor）— 词汇表中输入序列标记的索引。默认情况下，如果提供了填充，将会被忽略。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
什么是输入 ID？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()。
什么是解码器输入 ID？
M2M100 使用eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则可选择仅输入最后的decoder_input_ids（参见past_key_values）。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.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输入）。
如果使用了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.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 而不是一个普通的元组。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)
一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个torch.FloatTensor元组（如果传递了return_dict=False或当config.return_dict=False时），包括根据配置（M2M100Config）和输入的各种元素。
损失(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(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时返回) — 形状为(batch_size, sequence_length, hidden_size)的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 之后，用于计算自注意力头中的加权平均值。cross_attentions(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(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 的前向方法，覆盖了__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))
MADLAD-400
原文链接：
huggingface.co/docs/transformers/v4.37.2/en/model_doc/madlad-400
概述
MADLAD-400 模型在论文 MADLAD-400: A Multilingual And Document-Level Large Audited Dataset 中发布。
论文摘要如下：
我们介绍了 MADLAD-400，这是一个基于 CommonCrawl 的手动审核的通用领域 3T 令牌单语数据集，涵盖了 419 种语言。我们讨论了自我审核 MADLAD-400 所揭示的限制，以及数据审核在数据集创建过程中的作用。然后，我们使用公开可用的数据训练并发布了一个覆盖 450 多种语言、共计 2500 亿令牌的 10.7B 参数多语言机器翻译模型，并发现它与规模更大的模型竞争力相当，并在不同领域报告了结果。此外，我们训练了一个 8B 参数的语言模型，并评估了少样本翻译的结果。我们将基线模型提供给研究社区。
此模型由Juarez Bochi添加。原始检查点可以在这里找到。
这是一个支持许多低资源语言的机器翻译模型，并且与规模更大的模型具有竞争力。
可以直接使用 MADLAD-400 权重而无需微调模型：
>>> from transformers import AutoModelForSeq2SeqLM, AutoTokenizer >>> model = AutoModelForSeq2SeqLM.from_pretrained("google/madlad400-3b-mt") >>> tokenizer = AutoTokenizer.from_pretrained("google/madlad400-3b-mt") >>> inputs = tokenizer("<2pt> I love pizza!", return_tensors="pt") >>> outputs = model.generate(**inputs) >>> print(tokenizer.batch_decode(outputs, skip_special_tokens=True)) ['Eu amo pizza!']
Google 发布了以下变体：
原始检查点可以在这里找到。
有关所有 API 参考、代码示例和笔记本，请参考 T5 的文档页面。有关 MADLAD-400 的训练和评估的更多详细信息，请参考模型卡片。
Transformers 4.37 中文文档（四十二）（2）https://developer.aliyun.com/article/1565016
