Transformers 文档

UMT5

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

协作处理模型、数据集和 Spaces

通过加速推理获得更快的示例

切换文档主题

开始使用

UMT5

概述

UMT5 模型在 UniMax：用于大规模多语言预训练的更公平有效的语言采样中被提出，作者是 Hyung Won Chung、Xavier Garcia、Adam Roberts、Yi Tay、Orhan Firat、Sharan Narang、Noah Constant。

论文摘要如下

预训练的多语言大型语言模型通常使用启发式基于温度的采样来平衡不同语言之间的关系。然而，先前的工作并未系统地评估不同预训练语言分布在模型规模上的有效性。在本文中，我们提出了一种新的采样方法 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 可以表示的不同 token 的数量。
d_model (int，可选，默认为 512) — 编码器层和池化层的大小。
d_kv (int，可选，默认为 64) — 每个 attention head 的 key、query、value projection 的大小。d_kv 必须等于 d_model // num_heads。
d_ff (int，可选，默认为 1024) — 每个 UMT5Block 中间 feed forward 层的大小。
num_layers (int，可选，默认为 8) — Transformer 编码器中隐藏层的数量。
num_decoder_layers (int，可选) — Transformer 解码器中隐藏层的数量。如果未设置，将使用与 num_layers 相同的值。
num_heads (int，可选，默认为 6) — Transformer 编码器中每个 attention layer 的 attention head 数量。
relative_attention_num_buckets (int，可选，默认为 32) — 每个 attention layer 使用的 bucket 数量。
relative_attention_max_distance (int，可选，默认为 128) — bucket 分离的较长序列的最大距离。
dropout_rate (float，可选，默认为 0.1) — 所有 dropout 层的比率。
classifier_dropout (float，可选，默认为 0.0) — classifier 的 dropout 比率。
layer_norm_eps (float，可选，默认为 1e-6) — layer normalization 层使用的 epsilon 值。
initializer_factor (float，可选，默认为 1) — 初始化所有权重矩阵的因子（应保持为 1，内部用于初始化测试）。
feed_forward_proj (string，可选，默认为 "gated-gelu") — 要使用的 feed forward 层的类型。应为 "relu" 或 "gated-gelu" 之一。
use_cache (bool，可选，默认为 True) — 模型是否应返回最后的 key/values attentions（并非所有模型都使用）。

这是用于存储 UMT5Model 配置的配置类。它用于根据指定的参数实例化 UMT5 模型，从而定义模型架构。使用默认值实例化配置将产生与 UMT5 google/umt5-small 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

UMT5Model

class transformers.UMT5Model

< 源码 >

( config )

参数

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

裸 UMT5 模型 transformer 输出原始隐藏状态，顶部没有任何特定的 head。

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

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 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_state

forward

< 源码 >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)

参数

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

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

什么是输入 IDs？

要了解更多关于如何为预训练准备 input_ids 的信息，请查看 UMT5 训练。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对 padding token 索引执行 attention 的 mask。Mask 值在 [0, 1] 中选择：
- 1 表示 未被 mask 的 token，
- 0 表示 已被 mask 的 token。
什么是 attention masks？
decoder_input_ids (torch.LongTensor, 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列 tokens 在词汇表中的索引。

索引可以使用 AutoTokenizer 获得。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是解码器输入 IDs？

UMT5 使用 pad_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_ids（请参阅 past_key_values）。

要了解更多关于如何为预训练准备 decoder_input_ids 的信息，请查看 UMT5 训练。
decoder_attention_mask (torch.BoolTensor, 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个 tensor，忽略 decoder_input_ids 中的 pad tokens。默认情况下，也会使用因果掩码。
head_mask (torch.FloatTensor, 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置空编码器中 self-attention 模块的选定 head 的掩码。在 [0, 1] 中选择掩码值：
- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
decoder_head_mask (torch.FloatTensor, 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置空解码器中 self-attention 模块的选定 head 的掩码。在 [0, 1] 中选择掩码值：
- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
cross_attn_head_mask (torch.Tensor, 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置空解码器中 cross-attention 模块的选定 head 的掩码。在 [0, 1] 中选择掩码值：
- 1 表示 head 不被掩盖，
- 0 表示 head 被掩盖。
encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — Tuple 由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。 last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，是编码器最后一层的输出处的 hidden states 序列。在解码器的 cross-attention 中使用。
past_key_values (tuple(tuple(torch.FloatTensor)), 长度为 config.n_layers，每个 tuple 包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的 tensors) — 包含 attention blocks 的预计算 key 和 value hidden states。可用于加速解码。

如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（那些没有将其 past key value states 提供给此模型的），形状为 (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 key value states，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参见返回的 tensors 下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。
cache_position (torch.LongTensor, 形状为 (sequence_length), 可选) — 索引，描述输入序列 tokens 在序列中的位置。它用于在正确的位置更新缓存并推断完整的序列长度。

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

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (UMT5Config) 和输入。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出处的 hidden-states 序列。

如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，其中每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensors。

包含预计算的 hidden-states（self-attention blocks 和 cross-attention blocks 中的 key 和 values），可以用于（请参阅 past_key_values 输入）加速顺序解码。
decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

解码器在每一层输出处的 Hidden-states，加上可选的初始 embedding 输出。
decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。
encoder_last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的 hidden-states 序列。
encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

编码器在每一层输出处的 Hidden-states，加上可选的初始 embedding 输出。
encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

编码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。

UMT5Model forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数中定义，但应该在此之后调用 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_state

UMT5ForConditionalGeneration

class transformers.UMT5ForConditionalGeneration

< source >

( config )

参数

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

UMT5 模型，顶部带有一个 language modeling head。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 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.loss

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)

参数

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

索引可以使用 AutoTokenizer 获得。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是输入 IDs？

要了解更多关于如何为预训练准备 input_ids 的信息，请查看 UMT5 训练。
attention_mask (torch.FloatTensor, 形状为 (batch_size, sequence_length), 可选) — 掩码，以避免在 padding token 索引上执行 attention。在 [0, 1] 中选择掩码值：
- 1 表示 tokens 不被掩盖，
- 0 表示 tokens 被掩盖。
什么是 attention 掩码？
decoder_input_ids (torch.LongTensor, 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列 tokens 在词汇表中的索引。

索引可以使用 AutoTokenizer 获得。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是解码器输入 IDs？

UMT5 使用 pad_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_ids（请参阅 past_key_values）。

要了解更多关于如何为预训练准备 decoder_input_ids 的信息，请查看 UMT5 训练。
decoder_attention_mask (torch.BoolTensor, 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个 tensor，忽略 decoder_input_ids 中的 pad tokens。默认情况下，也会使用因果掩码。
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，optional: hidden_states，optional: 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 而不是普通的元组。
cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 索引，描述输入序列 token 在序列中的位置。它用于在正确的位置更新缓存并推断完整序列长度。
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 之前每个词汇表 token 的分数）。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，其中每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensors。

包含预计算的 hidden-states（self-attention blocks 和 cross-attention blocks 中的 key 和 values），可以用于（请参阅 past_key_values 输入）加速顺序解码。
decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

解码器在每一层输出的隐藏状态，加上初始嵌入输出。
decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。
encoder_last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的 hidden-states 序列。
encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

编码器在每一层输出的隐藏状态，加上初始嵌入输出。
encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

编码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。

UMT5ForConditionalGeneration 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> 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 模型 Transformer，输出编码器的原始隐藏状态，顶部没有任何特定的 head。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 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_state

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

要了解有关如何为预训练准备 input_ids 的更多信息，请查看 UMT5 训练。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。掩码值应在 [0, 1] 中选择：
- 1 表示 token 不被屏蔽，
- 0 表示 token 被屏蔽。
什么是注意力掩码？
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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

UMT5EncoderModel 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> 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_state

UMT5ForSequenceClassification

class transformers.UMT5ForSequenceClassification

< source >

( config: UMT5Config )

参数

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

UMT5 模型，顶部带有一个序列分类/头（池化输出顶部的线性层），例如用于 GLUE 任务。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。

forward

< source >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 ID？

要了解有关如何为预训练准备 input_ids 的更多信息，请查看 UMT5 训练。
attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 避免在 padding 标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
什么是注意力掩码？
decoder_input_ids (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor, 可选) — 词汇表中解码器输入序列标记的索引。

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

什么是解码器输入 ID？

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

要了解有关如何为预训练准备 decoder_input_ids 的更多信息，请查看 UMT5 训练。
decoder_attention_mask (形状为 (batch_size, target_sequence_length) 的 torch.BoolTensor, 可选) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 pad 标记。默认情况下，也将使用因果掩码。
head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor, 可选) — 用于 nullify 编码器中自注意力模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩盖，
- 0 表示头被掩盖。
decoder_head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor, 可选) — 用于 nullify 解码器中自注意力模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩盖，
- 0 表示头被掩盖。
cross_attn_head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.Tensor, 可选) — 用于 nullify 解码器中跨注意力模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩盖，
- 0 表示头被掩盖。
encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成，形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state 是编码器最后一层输出处的隐藏状态序列。用于解码器的跨注意力。
past_key_values (长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，其中每个元组有 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 (形状为 (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, optional) — 是否返回所有注意力层的注意力张量。详见返回张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。详见返回张量下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯元组。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 索引，描述输入序列 tokens 在序列中的位置。它用于在正确的位置更新缓存，并推断完整的序列长度。
labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [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 of shape (1,), optional, 当提供 label 时返回) — 分类（或回归，如果 config.num_labels==1）损失。
logits (torch.FloatTensor of shape (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，其中每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensors。

包含预计算的 hidden-states（self-attention blocks 和 cross-attention blocks 中的 key 和 values），可以用于（请参阅 past_key_values 输入）加速顺序解码。
decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

解码器在每一层输出的隐藏状态，加上初始嵌入输出。
decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。
encoder_last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的 hidden-states 序列。
encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

编码器在每一层输出的隐藏状态，加上初始嵌入输出。
encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

编码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。

UMT5ForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。

UMT5ForTokenClassification

class transformers.UMT5ForTokenClassification

< source >

( config: UMT5Config )

参数

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

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

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。

forward

< source >

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

参数

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

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

什么是输入 ID？

要了解有关如何为预训练准备 input_ids 的更多信息，请查看 UMT5 训练。
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行注意力的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示 未被掩码 的 tokens，
- 0 表示 被掩码 的 tokens。
什么是注意力掩码？
decoder_input_ids (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 词汇表中解码器输入序列 tokens 的索引。

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

什么是解码器输入 ID？

UMT5 使用 pad_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids（请参阅 past_key_values）。

要了解有关如何为预训练准备 decoder_input_ids 的更多信息，请查看 UMT5 训练。
decoder_attention_mask (torch.BoolTensor of shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的填充 tokens。默认情况下，也将使用因果掩码。
head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于使编码器中自注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示头 未被掩码，
- 0 表示头 被掩码。
decoder_head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于使解码器中自注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示头 未被掩码，
- 0 表示头 被掩码。
cross_attn_head_mask (torch.Tensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于使解码器中交叉注意力模块的选定头无效的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示头 未被掩码，
- 0 表示头 被掩码。
encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state 是编码器最后一层输出处的隐藏状态序列。在解码器的交叉注意力中使用。
past_key_values (tuple(tuple(torch.FloatTensor)) of length config.n_layers with each tuple having 4 tensors of shape (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 of shape (batch_size, sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, target_sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 decoder_input_ids。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_inputs_embeds（请参阅 past_key_values）。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 decoder_input_ids 索引转换为关联的向量，这将非常有用。

如果 decoder_input_ids 和 decoder_inputs_embeds 均未设置，则 decoder_inputs_embeds 取 inputs_embeds 的值。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。详见返回张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请查看返回张量下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 索引，描述输入序列 tokens 在序列中的位置。它用于在正确的位置更新缓存，并推断完整的序列长度。
labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算 token 分类损失的标签。索引应该在 [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 时)，包含各种元素，具体取决于配置 (UMT5Config) 和输入。

loss (torch.FloatTensor of shape (1,), optional, 当提供 labels 时返回) — 分类损失。
logits (torch.FloatTensor of 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

UMT5ForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。

UMT5ForQuestionAnswering

class transformers.UMT5ForQuestionAnswering

< source >

( config )

参数

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

UMT5 模型，顶部带有一个跨度分类头，用于抽取式问答任务，如 SQuAD (隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits)。

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

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 IDs？

要了解更多关于如何为预训练准备 input_ids 的信息，请查看 UMT5 训练。
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
什么是 attention 掩码？
decoder_input_ids (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 词汇表中解码器输入序列 tokens 的索引。

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

什么是解码器输入 IDs？

UMT5 使用 pad_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids (请参阅 past_key_values)。

要了解更多关于如何为预训练准备 decoder_input_ids 的信息，请查看 UMT5 训练。
decoder_attention_mask (torch.BoolTensor of shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的 pad tokens。默认情况下，还将使用因果掩码。
head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 掩盖编码器中 self-attention 模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
decoder_head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 掩盖解码器中 self-attention 模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
cross_attn_head_mask (torch.Tensor of shape (num_heads,) or (num_layers, num_heads), optional) — 掩盖解码器中 cross-attention 模块的选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被掩盖，
- 0 表示头 被掩盖。
encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state 是编码器最后一层输出端的隐藏状态序列。在解码器的 cross-attention 中使用。
past_key_values (tuple(tuple(torch.FloatTensor)) of length config.n_layers with each tuple having 4 tensors of shape (batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含 attention 块的预先计算的键和值隐藏状态。可用于加速解码。

如果使用 past_key_values，用户可以选择仅输入最后一个 decoder_input_ids (那些没有将其过去的键值状态提供给此模型的) 形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, target_sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_ids。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_inputs_embeds (请参阅 past_key_values)。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 decoder_input_ids 索引转换为关联的向量，这将非常有用。

如果 decoder_input_ids 和 decoder_inputs_embeds 均未设置，则 decoder_inputs_embeds 采用 inputs_embeds 的值。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码 (请参阅 past_key_values)。
output_attentions (bool, optional) — 是否返回所有 attention 层的 attention 张量。更多细节请查看返回张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请查看返回张量下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。
cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 索引，描述输入序列 tokens 在序列中的位置。它用于在正确的位置更新缓存，并推断完整的序列长度。
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 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的 Tuple，其中每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensors。

包含预计算的 hidden-states（self-attention blocks 和 cross-attention blocks 中的 key 和 values），可以用于（请参阅 past_key_values 输入）加速顺序解码。
decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

解码器在每一层输出的隐藏状态，加上初始嵌入输出。
decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。
encoder_last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出处的 hidden-states 序列。
encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出提供一个，+ 每个层的输出提供一个），形状为 (batch_size, sequence_length, hidden_size)。

编码器在每一层输出的隐藏状态，加上初始嵌入输出。
encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

编码器的 Attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。

UMT5ForQuestionAnswering 的 forward 方法，覆盖了 __call__ 特殊方法。

< > 在 GitHub 上更新

←UL2 X-MOD→