UMT5
概述
UMT5 模型由 Hyung Won Chung、Xavier Garcia、Adam Roberts、Yi Tay、Orhan Firat、Sharan Narang、Noah Constant 在 UniMax：大型多语言预训练中更公平、更有效的语言采样 中提出。
论文中的摘要如下：
预训练的多语言大型语言模型通常使用基于启发式温度的采样来平衡不同语言之间的权重。然而，以前的工作并没有系统地评估不同预训练语言分布在不同模型规模上的有效性。在本文中，我们提出了一种新的采样方法 UniMax，该方法通过明确限制每个语言语料库的重复次数，可以更均匀地覆盖主要语言，同时减轻对尾部语言的过度拟合。我们执行了一系列广泛的消融实验，测试了各种采样策略在多语言基准测试套件上的表现，同时改变模型规模。我们发现 UniMax 优于标准的基于温度的采样，并且随着规模的增加，这种优势仍然存在。作为我们贡献的一部分，我们发布了：（i）一个改进和更新的 mC4 多语言语料库，包含 107 种语言的 29 万亿个字符，以及（ii）使用 UniMax 采样训练的一套预训练的 umT5 模型检查点。
Google 发布了以下变体：
该模型由 agemagician 和 stefan-it 贡献。原始代码可以在 此处 找到。
使用技巧
- UMT5 仅在 mC4 上进行预训练，不包括任何监督训练。因此，与原始 T5 模型不同，此模型在可用于下游任务之前必须进行微调。
- 由于 umT5 是以无监督方式预训练的，因此在单任务微调期间使用任务前缀没有真正的好处。如果进行多任务微调，则应使用前缀。
与 mT5 有什么区别？
UmT5 基于 mT5，具有非共享的相对位置偏差，该偏差是针对每个层计算的。这意味着模型为每个层设置了 has_relative_bias。转换脚本也不同，因为模型是在 t5x 的最新检查点格式中保存的。
示例用法
>>> from transformers import AutoModelForSeq2SeqLM, AutoTokenizer
>>> model = AutoModelForSeq2SeqLM.from_pretrained("google/umt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-small")
>>> inputs = tokenizer(
... "A <extra_id_0> walks into a bar and orders a <extra_id_1> with <extra_id_2> pinch of <extra_id_3>.",
... return_tensors="pt",
... )
>>> outputs = model.generate(**inputs)
>>> print(tokenizer.batch_decode(outputs))
['<pad><extra_id_0>nyone who<extra_id_1> drink<extra_id_2> a<extra_id_3> alcohol<extra_id_4> A<extra_id_5> A. This<extra_id_6> I<extra_id_7><extra_id_52><extra_id_53></s>']有关更多提示、代码示例和笔记本，请参阅 T5 的文档页面。
UMT5Config
class transformers.UMT5Config
< 源代码 >( 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 = True pad_token_id = 0 eos_token_id = 1 decoder_start_token_id = 0 classifier_dropout = 0.0 **kwargs )
参数
- vocab_size (
int, 可选, 默认值为 250112) — UMT5 模型的词汇量大小。定义了调用 UMT5Model 或TFUMT5Model时，传递的inputs_ids可以表示的不同标记的数量。 - d_model (
int, 可选, 默认值为 512) — 编码器层和池化层的尺寸。 - d_kv (
int, 可选, 默认值为 64) — 每个注意力头的键、查询、值投影的尺寸。d_kv必须等于d_model // num_heads。 - d_ff (
int, 可选, 默认值为 1024) — 每个UMT5Block中中间前馈层的尺寸。 - num_layers (
int, 可选, 默认值为 8) — Transformer 编码器中的隐藏层数。 - num_decoder_layers (
int, 可选) — Transformer 解码器中的隐藏层数。如果没有设置，将使用与num_layers相同的值。 - num_heads (
int, 可选, 默认值为 6) — Transformer 编码器中每个注意力层中的注意力头数。 - relative_attention_num_buckets (
int, 可选, 默认值为 32) — 每个注意力层要使用的桶数。 - classifier_dropout (
float, 可选, 默认值 0.0) — 分类器的 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) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。
这是用于存储 UMT5Model 配置的配置类。它用于根据指定的参数实例化 UMT5 模型，定义模型架构。使用默认值实例化配置将产生类似于 UMT5 google/umt5-small 架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
UMT5Model
class transformers.UMT5Model
< 源代码 >( config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
UMT5 模型的基本转换器，输出原始隐藏状态，没有额外的头部。
UMT5 模型在 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 UMT5Model, AutoTokenizer
>>> model = UMT5Model.from_pretrained("google/umt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-small")
>>> noisy_text = "UN Offizier sagt, dass weiter <extra_id_0> werden muss in Syrien."
>>> label = "<extra_id_0> verhandelt"
>>> inputs = tokenizer(inputs, return_tensors="pt")
>>> labels = tokenizer(label=label, return_tensors="pt")
>>> outputs = model(input_ids=inputs["input_ids"], decoder_input_ids=labels["input_ids"])
>>> hidden_states = outputs.last_hidden_stateThe UMT5Model 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, UMT5Model
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-small")
>>> model = UMT5Model.from_pretrained("google/umt5-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 UMT5Model.
>>> # This is not needed for torch's UMT5ForConditionalGeneration 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_stateUMT5ForConditionalGeneration
class transformers.UMT5ForConditionalGeneration
< source >( config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
UMT5 模型，顶部带有 语言建模 头。
UMT5 模型在 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 UMT5ForConditionalGeneration, AutoTokenizer
>>> model = UMT5ForConditionalGeneration.from_pretrained("google/umt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-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.lossforward
< source >( 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 (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。UMT5 是一个具有相对位置嵌入的模型，因此你应该能够在左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
若要详细了解如何为预训练准备
input_ids，请查看 UMT5 训练。 - 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() 。
UMT5 使用
pad_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则可选地仅输入最后一个decoder_input_ids（请参阅past_key_values）。要详细了解如何为预训练准备
decoder_input_ids，请查看 UMT5 训练。 - 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 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置 (UMT5Config) 和输入的不同元素。
-
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时返回) —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元组 (每个层一个)。解码器交叉注意力层的注意力权重，在注意力 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 后，用于计算自注意力头中的加权平均值。
该 UMT5ForConditionalGeneration 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, UMT5ForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-small")
>>> model = UMT5ForConditionalGeneration.from_pretrained("google/umt5-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("Studies have shown that <extra_id_0> good for you", return_tensors="pt").input_ids
>>> outputs = model.generate(input_ids)
>>> tokenizer.decode(outputs[0], skip_special_tokens=True)UMT5EncoderModel
class transformers.UMT5EncoderModel
< source >( config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
最基本的 UMT5 模型变压器，输出编码器的原始隐藏状态，没有额外的头部。
UMT5 模型在 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 UMT5EncoderModel, AutoTokenizer
>>> model = UMT5EncoderModel.from_pretrained("google/umt5-small")
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-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_stateforward
< 源代码 >( 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 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。UMT5 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要详细了解如何为预训练准备
input_ids，请查看 UMT5 训练。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值选择在[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 时），包括根据配置 (UMT5Config) 和输入的不同元素。
-
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 UMT5EncoderModel forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, UMT5EncoderModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/umt5-small")
>>> model = UMT5EncoderModel.from_pretrained("google/umt5-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_stateUMT5ForSequenceClassification
class transformers.UMT5ForSequenceClassification
< source >( config: UMT5Config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
UMT5 模型，顶部带有序列分类/头部（池化输出顶部的线性层），例如用于 GLUE 任务。
UMT5 模型在 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
< source >( 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)) — 词汇表中输入序列词元的索引。UMT5 是一个具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。索引可以通过 AutoTokenizer 获得。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
要了解更多关于如何为预训练准备
input_ids的信息，请查看 UMT5 训练. - 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()。
UMT5 使用
pad_token_id作为decoder_input_ids生成的起始令牌。如果使用past_key_values，则可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。要了解有关如何为预训练准备
decoder_input_ids的更多信息，请查看 UMT5 训练。 - 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,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[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 时），其中包含根据配置（UMT5Config）和输入而不同的各种元素。
-
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时返回) —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元组 (每个层一个)。解码器交叉注意力层的注意力权重，在注意力 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 UMT5ForSequenceClassification 正向方法，重写了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。
UMT5ForTokenClassification
class transformers.UMT5ForTokenClassification
< source >( config: UMT5Config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
带有顶部标记分类头的 UMT5 编码器模型（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
UMT5 模型在 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 or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列词元在词表的索引。UMT5 模型使用相对位置嵌入，因此你可以在左侧和右侧对输入进行填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
若要详细了解如何为预训练准备
input_ids，请查看 UMT5 训练。 - 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()。
UMT5 使用
pad_token_id作为decoder_input_ids生成的起始词元。如果使用past_key_values，则可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。若要详细了解如何为预训练准备
decoder_input_ids，请查看 UMT5 训练。 - 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)，而不是所有形状为(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.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算令牌分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (UMT5Config) 和输入而变化的各种元素。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensorof shape(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 UMT5ForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。
UMT5ForQuestionAnswering
class transformers.UMT5ForQuestionAnswering
< source >( config )
参数
- config (UMT5Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
UMT5 模型，顶部带有一个跨度分类头，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出之上进行线性层计算，以计算 span start logits 和 span end logits）。
UMT5 模型在 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
< source >( 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.LongTensorof shape(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。UMT5 是一种具有相对位置嵌入的模型，因此您应该能够在左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
要详细了解如何为预训练准备
input_ids，请查看 UMT5 训练。 - attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 掩码，以避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 1 表示未屏蔽的标记。
- 0 表示屏蔽的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
UMT5 使用
pad_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。要了解有关如何为预训练准备
decoder_input_ids的更多信息，请查看 UMT5 训练。 - 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（那些没有为此模型提供其过去键值状态的）而不是形状为(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 而不是一个简单的元组。 - 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 时），包含取决于配置 (UMT5Config) 和输入的各种元素。
-
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时返回) —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元组 (每个层一个)。解码器交叉注意力层的注意力权重，在注意力 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 后，用于计算自注意力头中的加权平均值。
UMT5ForQuestionAnswering 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是这个，因为前者负责运行前处理和后处理步骤，而后者则静默地忽略它们。