Hugging Face 的徽标

Transformers 文档

mT5

Hugging Face's logo
加入 Hugging Face 社区

并获取增强型文档体验

开始使用

mT5

Models Spaces

概述

mT5 模型在 Linting Xue、Noah Constant、Adam Roberts、Mihir Kale、Rami Al-Rfou、Aditya Siddhant、Aditya Barua 和 Colin Raffel 的论文 mT5：一个大规模多语言预训练文本到文本 Transformer 中提出。

论文中的摘要如下：

最近的“文本到文本迁移 Transformer”（T5）利用统一的文本到文本格式和规模，在各种英语 NLP 任务中取得了最先进的结果。在本文中，我们介绍了 mT5，这是 T5 的多语言变体，它是在一个新的基于 Common Crawl 的数据集上进行预训练的，该数据集涵盖了 101 种语言。我们详细介绍了 mT5 的设计和修改后的训练，并展示了它在许多多语言基准测试中的最先进性能。我们还描述了一种简单的技术，可以防止在零样本设置中出现“意外翻译”，在这种情况下，生成模型选择将它的预测（部分地）翻译成错误的语言。本文中使用的所有代码和模型检查点都已公开提供。

注意：mT5 仅在 mC4 上进行预训练，不包括任何监督训练。因此，此模型必须在用于下游任务之前进行微调，这与原始 T5 模型不同。由于 mT5 是无监督地进行预训练的，因此在单任务微调期间使用任务前缀没有真正的优势。如果进行多任务微调，则应使用前缀。

Google 发布了以下变体：

此模型由 patrickvonplaten 贡献。原始代码可以在 此处 找到。

资源

MT5Config

class transformers.MT5Config

< >

( vocab_size = 250112 d_model = 512 d_kv = 64 d_ff = 1024 num_layers = 8 num_decoder_layers = None num_heads = 6 relative_attention_num_buckets = 32 relative_attention_max_distance = 128 dropout_rate = 0.1 layer_norm_epsilon = 1e-06 initializer_factor = 1.0 feed_forward_proj = 'gated-gelu' is_encoder_decoder = True use_cache = True tokenizer_class = 'T5Tokenizer' tie_word_embeddings = False pad_token_id = 0 eos_token_id = 1 decoder_start_token_id = 0 classifier_dropout = 0.0 **kwargs )

参数

  • 词汇量 (int, 可选, 默认值为 250112) — T5 模型的词汇量。定义了调用 T5Model 或 TFT5Model 时传递的 inputs_ids 可以表示的不同标记的数量。
  • 模型维度 (int, 可选, 默认值为 512) — 编码器层和池化层的维度。
  • 键、查询、值投影维度 (int, 可选, 默认值为 64) — 每个注意力头的键、查询、值投影的维度。在传统情况下，通常期望 d_kv 等于 d_model // num_heads。但在 mt5-small 的架构中，d_kv 不等于 d_model //num_heads。投影层的 inner_dim 将被定义为 num_heads * d_kv。
  • 前馈层维度 (int, 可选, 默认值为 1024) — 每个 T5Block 中的中间前馈层的维度。
  • 编码器层数 (int, 可选, 默认值为 8) — 变压器编码器中的隐藏层数。
  • 解码器层数 (int, 可选) — 变压器解码器中的隐藏层数。如果未设置，将使用与 num_layers 相同的值。
  • 注意力头数 (int, 可选, 默认值为 6) — 变压器编码器中每个注意力层的注意力头数。
  • 相对注意力桶数 (int, 可选, 默认值为 32) — 每个注意力层使用的桶数。
  • 相对注意力最大距离 (int, 可选, 默认值为 128) — 桶分离的较长序列的最大距离。
  • dropout 比率 (float, 可选, 默认值为 0.1) — 所有 dropout 层的比率。
  • layer_norm_eps (float, 可选, 默认为 1e-6) — 层归一化层使用的epsilon。
  • initializer_factor (float, 可选, 默认为 1) — 用于初始化所有权重矩阵的因子（应保持为 1，在内部用于初始化测试）。
  • feed_forward_proj (string, 可选, 默认为 "gated-gelu") — 要使用的前馈层类型。应该是 "relu" 或 "gated-gelu" 之一。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。

这是一个配置类，用于存储 MT5Model 或 TFMT5Model 的配置。它用于根据指定的参数实例化 mT5 模型，定义模型架构。使用默认值实例化配置将产生与 mT5 google/mt5-small 架构类似的配置。

配置对象继承自 PretrainedConfig 并且可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

MT5Tokenizer

class transformers.T5Tokenizer

< >

( vocab_file eos_token = '</s>' unk_token = '<unk>' pad_token = '<pad>' extra_ids = 100 additional_special_tokens = None sp_model_kwargs: Optional = None legacy = None add_prefix_space = True **kwargs )

参数

  • vocab_file (str) — SentencePiece 文件（通常具有 .spm 扩展名），其中包含实例化标记器所需的词汇表。
  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

    使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是 sep_token。
  • unk_token (str, 可选, 默认为 "<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。
  • pad_token (str, optional, defaults to "<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。
  • extra_ids (int, optional, defaults to 100) — 向词汇表添加一些额外的 id，用于作为哨兵。这些标记可以访问为“id{%d}>” 其中 ”{%d}” 是 0 到 extra_ids-1 之间的数字。这些标记可以通过调用 get_sentinel_tokens 方法获取，而标记 id 可以通过调用 get_sentinel_token_ids 方法获取。additional_special_tokens (List[str], optional): 标记器使用的其他特殊标记。
  • sp_model_kwargs (dict, optional) — 将传递给 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 的合并操作的 dropout 概率。
  • legacy (bool, optional) — 是否应该使用标记器的 legacy 行为。Legacy 是在合并 #24622 和 #25224 之前，其中包括对正确处理出现在特殊标记后的标记的修复。一个简单的例子：

    • legacy=True:

构造一个 T5 标记器。基于 SentencePiece.

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

build_inputs_with_special_tokens

< >

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

参数

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

返回

List[int]

具有适当特殊标记的 输入 ID 列表。

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

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

convert_tokens_to_string

< >

( tokens )

将标记序列（字符串）转换为单个字符串。

create_token_type_ids_from_sequences

<

参数

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

返回

List[int]

零的列表。

从传递的两个序列中创建一个掩码，用于序列对分类任务。T5 不使用 token type id，因此返回一个零列表。

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], optional) — 用于序列对的可选第二个 ID 列表。
  • already_has_special_tokens (bool, optional, defaults to False) — 该 token 列表是否已使用模型的特殊 token 进行格式化。

返回

List[int]

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

从没有添加特殊 token 的 token 列表中检索序列 ID。在使用 tokenizer 的 prepare_for_model 方法添加特殊 token 时调用此方法。

tokenize

< >

( text: TextInput **kwargs )

将字符串转换为 token 列表。如果 self.legacy 设置为 False，则添加前缀 token，除非第一个 token 是特殊的。

有关所有详细信息，请参阅 T5Tokenizer。

MT5TokenizerFast

class transformers.T5TokenizerFast

< >

( vocab_file = None tokenizer_file = None eos_token = '</s>' unk_token = '<unk>' pad_token = '<pad>' extra_ids = 100 additional_special_tokens = None add_prefix_space = None **kwargs )

参数

  • vocab_file (str) — SentencePiece 文件（通常具有 .spm 扩展名），其中包含实例化标记器的必要词汇。
  • eos_token (str, 可选，默认为 "</s>") — 序列结束标记。
  • unk_token (str, 可选，默认为 "<unk>") — 未知标记。词汇表中不存在的标记无法转换为 ID，因此设置为该标记。
  • pad_token (str, 可选，默认为 "<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。
  • extra_ids (int, 可选，默认为 100) — 添加到词汇表中的额外 ID 数量，用于作为哨兵。这些标记可以作为“id{%d}>”访问，其中“{%d}”是 0 到 extra_ids-1 之间的数字。这些标记可以通过调用 get_sentinel_tokens 方法检索，标记 ID 可以通过调用 get_sentinel_token_ids 方法检索。
  • additional_special_tokens (List[str], 可选) — 标记器使用的其他特殊标记。
  • add_prefix_space (bool, 可选) — 标记器是否应自动添加前缀空格
  • from_slow (book, 可选，默认为 False) — 标记器是否应该从一个慢速标记器转换而来。如果 add_prefix_space 设置为真，则此值将设置为 True。

构建一个“快速”T5 标记器（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。

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

build_inputs_with_special_tokens

< >

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

参数

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

返回

List[int]

具有适当特殊标记的 输入 ID 列表。

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

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回

List[int]

零的列表。

从传递的两个序列中创建一个掩码，用于序列对分类任务。T5 不使用 token type id，因此返回一个零列表。

有关所有详细信息，请参阅 T5TokenizerFast。

Pytorch
隐藏 Pytorch 内容

MT5Model

class transformers.MT5Model

< >

( config: MT5Config )

参数

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

不带任何特定头的基本 MT5 模型变压器，输出原始隐藏状态。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

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

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

示例

>>> from transformers import MT5Model, AutoTokenizer

>>> model = MT5Model.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, return_tensors="pt")
>>> labels = tokenizer(text_target=summary, return_tensors="pt")

>>> outputs = model(input_ids=inputs["input_ids"], decoder_input_ids=labels["input_ids"])
>>> hidden_states = outputs.last_hidden_state

deparallelize

< >

( )

将模型从模型并行状态移动到 cpu。

示例

# On a 4 GPU machine with mt5-xl:
model = MT5ForConditionalGeneration.from_pretrained("Mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)  # Splits the model across several devices
model.deparallelize()  # Put the model back on cpu and cleans memory by calling torch.cuda.empty_cache()

forward

transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。MT5 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。

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

    什么是输入 ID？

    要了解有关如何为预训练准备 input_ids 的更多信息，请查看 MT5 训练。

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

    • 1 表示未屏蔽的标记，
    • 0 表示已屏蔽的标记。

    什么是注意力掩码？

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

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

    什么是解码器输入 ID？

    MT5 使用 pad_token_id 作为 decoder_input_ids 生成 的起始标记。如果使用 past_key_values，可以选择仅输入最后一个 decoder_input_ids（请参见 past_key_values）。

    要了解有关如何为预训练准备 decoder_input_ids 的更多信息，请查看 MT5 训练。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个张量，忽略 decoder_input_ids 中的填充标记。因果掩码也会默认使用。
  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码以使编码器中自注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值：

    • 1 表示未屏蔽的头部，
    • 0 表示已屏蔽的头部。
  • decoder_head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码以使解码器中自注意力模块的选定头部无效。在 [0, 1] 中选择的掩码值：

    • 1 表示未屏蔽的头部，
    • 0 表示已屏蔽的头部。
  • cross_attn_head_mask (torch.Tensor 形状为 (num_heads,) 或 (num_layers, num_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)) 长度为 config.n_layers，每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values，用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids （这些 decoder_input_ids 没有提供给该模型的过去键值状态），而不是所有形状为 (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 而不是一个简单的元组。

返回

transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（MT5Config）和输入的各种元素。

  • 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 时返回) — tuple(torch.FloatTensor) 的元组，长度为 config.n_layers，每个元组包含 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 (形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • 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之后，用于计算自注意力头部的加权平均值。

The MT5Model 正向方法覆盖了__call__特殊方法。

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, MT5Model

>>> tokenizer = AutoTokenizer.from_pretrained("google-mt5/mt5-small")
>>> model = MT5Model.from_pretrained("google-mt5/mt5-small")

>>> input_ids = tokenizer(
...     "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids  # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids  # Batch size 1

>>> # preprocess: Prepend decoder_input_ids with start token which is pad token for MT5Model.
>>> # This is not needed for torch's MT5ForConditionalGeneration as it does this internally using labels arg.
>>> decoder_input_ids = model._shift_right(decoder_input_ids)

>>> # forward pass
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)
>>> last_hidden_states = outputs.last_hidden_state

并行化

< >

( device_map = None )

参数

  • device_map (Dict[int, list], 可选) — 将注意力模块映射到设备的字典。请注意，嵌入模块和LMHead始终自动映射到第一个设备（出于玄学原因）。这意味着第一个设备映射的注意力模块应该少于其他设备。作为参考，mt5 模型具有以下数量的注意力模块：

    • mt5-small: 6
    • mt5-base: 12
    • mt5-large: 24
    • mt5-xl: 24
    • mt5-xxl: 24

这是一个实验性功能，随时可能发生变化。

使用设备映射将模型的注意力模块分布到多个设备上。如果没有提供设备映射，它将均匀地将块分布到所有设备上。

示例

# Here is an example of a device map on a machine with 4 GPUs using mt5-xl, which has a total of 24 attention modules:
model = MT5ForConditionalGeneration.from_pretrained("mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)

MT5ForConditionalGeneration

class transformers.MT5ForConditionalGeneration

< >

( config: MT5Config )

参数

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

具有语言建模头的MT5模型。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

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

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

示例

>>> from transformers import MT5ForConditionalGeneration, AutoTokenizer

>>> model = MT5ForConditionalGeneration.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, text_target=summary, return_tensors="pt")

>>> outputs = model(**inputs)
>>> loss = outputs.loss

deparallelize

< >

( )

将模型从模型并行状态移动到 cpu。

示例

# On a 4 GPU machine with mt5-xl:
model = MT5ForConditionalGeneration.from_pretrained("Mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)  # Splits the model across several devices
model.deparallelize()  # Put the model back on cpu and cleans memory by calling torch.cuda.empty_cache()

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 ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 句子中每个词在词表的索引。MT5 模型使用相对位置嵌入，因此你可以在句子左右两端进行填充。

    可以使用 AutoTokenizer 获取索引。详细内容请查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入索引?

    想了解更多关于如何在预训练中准备 input_ids 的信息，请查看 MT5 训练。

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码，用于避免在填充索引上执行注意力。掩码值选择范围在 [0, 1] 中:

    • 1 代表未被掩码的词，
    • 0 代表被掩码的词。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入句子中每个词在词表的索引。

    可以使用 AutoTokenizer 获取索引。详细内容请查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是解码器输入索引?

    MT5 使用 pad_token_id 作为 decoder_input_ids 生成的起始词。如果使用了 past_key_values，可选地只需要输入最后一个 decoder_input_ids（请查看 past_key_values）。

    想了解更多关于如何在预训练中准备 decoder_input_ids 的信息，请查看 MT5 训练。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为: 生成一个张量，忽略 decoder_input_ids 中的填充词。默认情况下还会使用因果掩码。
  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码，用于使编码器中自注意力模块的选定注意力头无效。掩码值选择范围在 [0, 1] 中:

    • 1 代表未被掩码的注意力头，
    • 0 代表被掩码的注意力头。
  • decoder_head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码，用于使解码器中自注意力模块的选定注意力头无效。掩码值选择范围在 [0, 1] 中:

    • 1 代表未被掩码的注意力头，
    • 0 代表被掩码的注意力头。
  • cross_attn_head_mask (torch.Tensor 形状为 (num_heads,) 或 (num_layers, num_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)) 长度为 config.n_layers，每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可以用来加速解码。

    如果使用了 past_key_values，用户可以选择仅输入最后一个 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_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,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 中。所有设置为 -100 的标签都将被忽略 (屏蔽)，损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回

transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)

A transformers.modeling_outputs.Seq2SeqLMOutput 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (MT5Config) 和输入的不同元素。

  • 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=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 的元组，长度为 config.n_layers，每个元组包含 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 (形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • 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之后，用于计算自注意力头部的加权平均值。

The MT5ForConditionalGeneration forward method, overrides the __call__ special method.

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, MT5ForConditionalGeneration

>>> tokenizer = AutoTokenizer.from_pretrained("google-mt5/mt5-small")
>>> model = MT5ForConditionalGeneration.from_pretrained("google-mt5/mt5-small")

>>> # training
>>> input_ids = tokenizer("The <extra_id_0> walks in <extra_id_1> park", return_tensors="pt").input_ids
>>> labels = tokenizer("<extra_id_0> cute dog <extra_id_1> the <extra_id_2>", return_tensors="pt").input_ids
>>> outputs = model(input_ids=input_ids, labels=labels)
>>> loss = outputs.loss
>>> logits = outputs.logits

>>> # inference
>>> input_ids = tokenizer(
...     "summarize: studies have shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids  # Batch size 1
>>> outputs = model.generate(input_ids)
>>> print(tokenizer.decode(outputs[0], skip_special_tokens=True))
>>> # studies have shown that owning a dog is good for you.

并行化

< >

( device_map = None )

参数

  • device_map (Dict[int, list], optional) — 一个字典，将注意力模块映射到设备。请注意，嵌入模块和 LMHead 总是自动映射到第一个设备（由于一些难以解释的原因）。这意味着第一个设备应该映射的注意力模块比其他设备少。作为参考，mt5 模型具有以下数量的注意力模块：

    • mt5-small: 6
    • mt5-base: 12
    • mt5-large: 24
    • mt5-xl: 24
    • mt5-xxl: 24

这是一个实验性功能，随时可能发生变化。

使用设备映射将模型的注意力模块分布到多个设备上。如果没有提供设备映射，它将均匀地将块分布到所有设备上。

示例

# Here is an example of a device map on a machine with 4 GPUs using mt5-xl, which has a total of 24 attention modules:
model = MT5ForConditionalGeneration.from_pretrained("mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)

MT5EncoderModel

class transformers.MT5EncoderModel

< >

( config: MT5Config )

参数

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

裸 MT5 模型转换器，输出编码器原始隐藏状态，顶部没有任何特定头部。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

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

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

示例

>>> from transformers import MT5EncoderModel, AutoTokenizer

>>> model = MT5EncoderModel.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> input_ids = tokenizer(article, return_tensors="pt").input_ids
>>> outputs = model(input_ids)
>>> hidden_state = outputs.last_hidden_state

deparallelize

< >

( )

将模型从模型并行状态移动到 cpu。

示例

# On a 4 GPU machine with mt5-xl:
model = MT5ForConditionalGeneration.from_pretrained("Mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)  # Splits the model across several devices
model.deparallelize()  # Put the model back on cpu and cleans memory by calling torch.cuda.empty_cache()

forward

< >

( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。MT5 是一个具有相对位置嵌入的模型，因此你应该能够在左右两侧填充输入。

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

    要详细了解如何为预训练准备 input_ids，请查看 MT5 训练。

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 掩码以避免对填充令牌索引执行注意力。在 [0, 1] 中选择掩码值：

    • 1 用于未被掩码的令牌，
    • 0 用于被掩码的令牌。
    • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值在 [0, 1] 中选择：

      • 1 表示头部未被掩码，
      • 0 表示头部被掩码。
    • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将很有用。
    • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的 attentions。
    • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的 hidden_states。
    • return_dict (bool，可选) — 是否返回 ModelOutput 而不是简单元组。

    返回

    transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

    一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (MT5Config) 和输入的各种元素。

    • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

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

      模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。

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

      注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

The MT5EncoderModel 正向方法，覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, MT5EncoderModel

>>> tokenizer = AutoTokenizer.from_pretrained("google-mt5/mt5-small")
>>> model = MT5EncoderModel.from_pretrained("google-mt5/mt5-small")
>>> input_ids = tokenizer(
...     "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids  # Batch size 1
>>> outputs = model(input_ids=input_ids)
>>> last_hidden_states = outputs.last_hidden_state

并行化

< >

( device_map = None )

参数

  • device_map (Dict[int, list]，可选) — 一个字典，将注意力模块映射到设备。请注意，嵌入模块和 LMHead 始终自动映射到第一个设备（出于神秘的原因）。这意味着第一个设备映射的注意力模块应该比其他设备少。作为参考，mt5 模型具有以下数量的注意力模块：

    • mt5-small: 6
    • mt5-base: 12
    • mt5-large: 24
    • mt5-xl: 24
    • mt5-xxl: 24

这是一个实验性功能，随时可能发生变化。

使用设备映射将模型的注意力模块分布到多个设备上。如果没有提供设备映射，它将均匀地将块分布到所有设备上。

示例

# Here is an example of a device map on a machine with 4 GPUs using mt5-xl, which has a total of 24 attention modules:
model = MT5ForConditionalGeneration.from_pretrained("mt5-xl")
device_map = {
    0: [0, 1, 2],
    1: [3, 4, 5, 6, 7, 8, 9],
    2: [10, 11, 12, 13, 14, 15, 16],
    3: [17, 18, 19, 20, 21, 22, 23],
}
model.parallelize(device_map)

MT5ForSequenceClassification

class transformers.MT5ForSequenceClassification

< >

( config: MT5Config )

参数

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

具有序列分类/头的 MT5 模型（在池化输出之上有一个线性层），例如用于 GLUE 任务。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

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

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

forward

< >

( input_ids: LongTensor = 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 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.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。 MT5 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。

    索引可以通过 AutoTokenizer 获取。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID？

    要了解有关如何为预训练准备 input_ids 的更多信息，请查看 MT5 训练。

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充词元索引执行注意力。 掩码值在 [0, 1] 中选择：

    • 1 表示未掩码的词元。
    • 0 表示掩码的词元。

    什么是注意力掩码？

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

    索引可以通过 AutoTokenizer 获取。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

    什么是解码器输入 ID？

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

    要了解有关如何为预训练准备 decoder_input_ids 的更多信息，请查看 MT5 训练。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个张量，忽略 decoder_input_ids 中的填充词元。 默认情况下还会使用因果掩码。
  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码以使编码器中自注意力模块的选定头无效。 掩码值在 [0, 1] 中选择：

    • 1 表示未掩码的头。
    • 0 表示掩码的头。
  • decoder_head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于将解码器中自注意力模块的选定头部设为零的掩码。掩码值选择在 [0, 1] 中：

    • 1 表示头部未被掩码，
    • 0 表示头部被掩码。
  • cross_attn_head_mask (torch.Tensor 形状为 (num_heads,) 或 (num_layers, num_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)) 长度为 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)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 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,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels > 1，则计算分类损失（交叉熵）。

返回

transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含各种元素，具体取决于配置 (MT5Config) 和输入。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 label 时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 的元组，长度为 config.n_layers，每个元组包含 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 (形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • 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之后，用于计算自注意力头部的加权平均值。

The MT5ForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

MT5ForTokenClassification

class transformers.MT5ForTokenClassification

< >

( config: MT5Config )

参数

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

MT5 编码器模型，顶部带有令牌分类头（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

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

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。MT5 是一个具有相对位置嵌入的模型，因此你应该能够在左右两边填充输入。

    可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID？

    要了解有关如何为预训练准备 input_ids 的更多信息，请查看 MT5 训练。

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行注意力。掩码值选择在 [0, 1] 中：

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

    什么是注意力掩码？

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

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

    什么是解码器输入 ID？

    MT5 使用 pad_token_id 作为 decoder_input_ids 生成 的起始令牌。如果使用 past_key_values，可以选择仅输入最后一个 decoder_input_ids（参见 past_key_values）。

    要详细了解如何在预训练中准备 decoder_input_ids，请查看 MT5 训练。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个张量，它会忽略 decoder_input_ids 中的填充令牌。默认情况下还会使用因果掩码。
  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码，用于在编码器中的自注意力模块中使选定的头部失效。在 [0, 1] 中选择的掩码值：

    • 1 表示头部 未被掩码
    • 0 表示头部 被掩码
  • decoder_head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码，用于在解码器中的自注意力模块中使选定的头部失效。在 [0, 1] 中选择的掩码值：

    • 1 表示头部 未被掩码
    • 0 表示头部 被掩码
  • cross_attn_head_mask (torch.Tensor 形状为 (num_heads,) 或 (num_layers, num_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)) 长度为 config.n_layers，每个元组有 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_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.num_labels - 1] 中。

返回

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (MT5Config) 和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 分类损失。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.num_labels)) — 分类分数（在 SoftMax 之前）。

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

    模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。

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

    注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

The MT5ForTokenClassification 正向方法，覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

MT5ForQuestionAnswering

class transformers.MT5ForQuestionAnswering

< >

( config: MT5Config )

参数

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

MT5 模型，顶部有一个跨度分类头，用于执行 SQuAD 之类的提取式问答任务（在隐藏状态输出的顶部使用线性层来计算 span start logits 和 span end logits）。

MT5 模型在 Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer 中由 Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li、Peter J. Liu 提出。它是在文本到文本降噪生成设置中预训练的编码器解码器变压器。

此模型继承自 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 start_positions: Optional = None end_positions: 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 ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列词元的索引。MT5 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。

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

    什么是输入 ID？

    有关如何为预训练准备 input_ids 的更多信息，请查看 MT5 训练。

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 掩码以避免对填充词元索引执行注意力。掩码值选择在 [0, 1] 中：

    • 1 表示未被掩码的词元，
    • 0 表示被掩码的词元。

    什么是注意力掩码？

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

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

    什么是解码器输入 ID？

    MT5 使用 pad_token_id 作为 decoder_input_ids 生成 的起始词元。如果使用 past_key_values，则可以选择只输入最后一个 decoder_input_ids（见 past_key_values）。

    有关如何为预训练准备 decoder_input_ids 的更多信息，请查看 MT5 训练。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略 decoder_input_ids 中填充词元的张量。因果掩码也将默认使用。
  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码以使编码器中自注意力模块的选定头部无效。掩码值选择在 [0, 1] 中：

    • 1 表示未被掩码的头部，
    • 0 表示被掩码的头部。
  • decoder_head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码以使解码器中自注意力模块的选定头部无效。掩码值选择在 [0, 1] 中：

    • 1 表示未被掩码的头部，
    • 0 表示被掩码的头部。
  • cross_attn_head_mask (torch.Tensor 形状为 (num_heads,) 或 (num_layers, num_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)) 长度为 config.n_layers，每个元组有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values，用户可以选择仅输入最后一个 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_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 而不是普通元组。
  • start_positions (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。
  • end_positions (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。

返回

transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False 时），包含取决于配置 (MT5Config) 和输入的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)，可选，在提供 labels 时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。

  • end_logits (torch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 的元组，长度为 config.n_layers，每个元组包含 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 (形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。

  • 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之后，用于计算自注意力头部的加权平均值。

该 MT5ForQuestionAnswering 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在该函数中定义，但之后应该调用Module实例而不是该函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

TensorFlow
隐藏 TensorFlow 内容

TFMT5Model

class transformers.TFMT5Model

< >

( *args **kwargs )

此类覆盖了 TFT5Model。请查看超类以获取适当的文档以及使用示例。

示例

>>> from transformers import TFMT5Model, AutoTokenizer

>>> model = TFMT5Model.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, return_tensors="tf")
>>> labels = tokenizer(text_target=summary, return_tensors="tf")

>>> outputs = model(input_ids=inputs["input_ids"], decoder_input_ids=labels["input_ids"])
>>> hidden_states = outputs.last_hidden_state

TFMT5ForConditionalGeneration

class transformers.TFMT5ForConditionalGeneration

< >

( *args **kwargs )

此类覆盖了 TFT5ForConditionalGeneration。请查看超类以获取适当的文档以及使用示例。

示例

>>> from transformers import TFMT5ForConditionalGeneration, AutoTokenizer

>>> model = TFMT5ForConditionalGeneration.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, text_target=summary, return_tensors="tf")

>>> outputs = model(**inputs)
>>> loss = outputs.loss

TFMT5EncoderModel

class transformers.TFMT5EncoderModel

< >

( *args **kwargs )

此类覆盖了 TFT5EncoderModel。请查看超类以获取适当的文档以及使用示例。

示例

>>> from transformers import TFMT5EncoderModel, AutoTokenizer

>>> model = TFMT5EncoderModel.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")
>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> input_ids = tokenizer(article, return_tensors="tf").input_ids
>>> outputs = model(input_ids)
>>> hidden_state = outputs.last_hidden_state
JAX
隐藏 JAX 内容

FlaxMT5Model

class transformers.FlaxMT5Model

< >

( config: T5Config input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

此类覆盖了 FlaxT5Model。请查看超类以获取相应的文档以及使用示例。

示例

>>> from transformers import FlaxMT5Model, AutoTokenizer

>>> model = FlaxMT5Model.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")

>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, return_tensors="np")

>>> decoder_input_ids = tokenizer(text_target=summary, return_tensors="np").input_ids

>>> outputs = model(input_ids=inputs["input_ids"], decoder_input_ids=decoder_input_ids)
>>> hidden_states = outputs.last_hidden_state

FlaxMT5ForConditionalGeneration

类 transformers.FlaxMT5ForConditionalGeneration

< >

( config: T5Config input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

此类覆盖了 FlaxT5ForConditionalGeneration。请查看超类以获取相应的文档以及使用示例。

示例

>>> from transformers import FlaxMT5ForConditionalGeneration, AutoTokenizer

>>> model = FlaxMT5ForConditionalGeneration.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")

>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, return_tensors="np")

>>> decoder_input_ids = tokenizer(text_target=summary, return_tensors="np").input_ids

>>> outputs = model(**inputs, decoder_input_ids=decoder_input_ids)
>>> logits = outputs.logits

FlaxMT5EncoderModel

类 transformers.FlaxMT5EncoderModel

< >

( config: T5Config input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

此类覆盖了 FlaxT5EncoderModel。请查看超类以获取相应的文档以及使用示例。

示例

>>> from transformers import FlaxT5EncoderModel, AutoTokenizer

>>> model = FlaxT5EncoderModel.from_pretrained("google/mt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/mt5-small")

>>> article = "UN Offizier sagt, dass weiter verhandelt werden muss in Syrien."
>>> summary = "Weiter Verhandlung in Syrien."
>>> inputs = tokenizer(article, return_tensors="np")

>>> decoder_input_ids = tokenizer(text_target=summary, return_tensors="np").input_ids

>>> outputs = model(input_ids=inputs["input_ids"])
>>> hidden_states = outputs.last_hidden_state
< > 在GitHub上更新

←MRA MVP→