参数

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

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

  什么是输入 ID？

  要了解有关为预训练准备 input_ids 的更多信息，请参阅 UMT5 训练。

• attention_mask (torch.FloatTensor, shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1]：
  • 1 表示 未掩码 的 tokens，
  • 0 表示 被掩码 的 tokens。

  什么是注意力掩码？

• decoder_input_ids (torch.LongTensor, 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, shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略 decoder_input_ids 中填充 tokens 的张量。默认情况下也会使用因果掩码。
• encoder_outputs (tuple, optional) — 由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成的元组。last_hidden_state 的 shape 为 (batch_size, sequence_length, hidden_size)，optional）是编码器最后一层的隐藏状态序列。用于解码器的交叉注意力。
• past_key_values (~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由当 use_cache=True 或 config.use_cache=True 时模型在先前解码阶段返回的 past_key_values 组成。

  仅允许 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认将初始化 DynamicCache。

  模型将输出与输入相同的缓存格式。

  如果使用 past_key_values，用户应仅输入未处理的 input_ids（其过去键值状态未提供给此模型的那些），其 shape 为 (batch_size, unprocessed_length)，而不是所有 input_ids 的 shape (batch_size, sequence_length)。

• inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关的向量，则此选项很有用。
• decoder_inputs_embeds (torch.Tensor, 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, shape (sequence_length), optional) — 指示输入序列 tokens 在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整序列长度。

返回一个 Seq2SeqModelOutput 或一个元组（如果传入 return_dict=False 或当 config.return_dict=False 时，则为 torch.FloatTensor 元组），其中包含各种元素，具体取决于配置（UMT5Config）和输入。

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

  如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

• past_key_values (EncoderDecoderCache, optional, 当传入 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

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

  解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

• decoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

• cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

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

  编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

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

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

  什么是输入 ID？

  要了解有关为预训练准备 input_ids 的更多信息，请参阅 UMT5 训练。

• attention_mask (torch.FloatTensor, shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1]：
  • 1 表示 未掩码 的 tokens，
  • 0 表示 被掩码 的 tokens。

  什么是注意力掩码？

• decoder_input_ids (torch.LongTensor, 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, shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略 decoder_input_ids 中填充 tokens 的张量。默认情况下也会使用因果掩码。
• encoder_outputs (tuple, optional) — 由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成的元组。last_hidden_state 的 shape 为 (batch_size, sequence_length, hidden_size)，optional）是编码器最后一层的隐藏状态序列。用于解码器的交叉注意力。
• past_key_values (~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由当 use_cache=True 或 config.use_cache=True 时模型在先前解码阶段返回的 past_key_values 组成。

  仅允许 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认将初始化 DynamicCache。

  模型将输出与输入相同的缓存格式。

  如果使用 past_key_values，用户应仅输入未处理的 input_ids（其过去键值状态未提供给此模型的那些），其 shape 为 (batch_size, unprocessed_length)，而不是所有 input_ids 的 shape (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor, shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关的向量，则此选项很有用。
• decoder_inputs_embeds (torch.FloatTensor, 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。

• labels (torch.LongTensor, shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 范围内。所有设置为 -100 的标签都将被忽略（掩码），损失仅为 [0, ..., config.vocab_size] 范围内的标签计算
• 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, shape (sequence_length), optional) — 指示输入序列 tokens 在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整序列长度。

返回一个 Seq2SeqLMOutput 或一个元组（如果传入 return_dict=False 或当 config.return_dict=False 时，则为 torch.FloatTensor 元组），其中包含各种元素，具体取决于配置（UMT5Config）和输入。

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

• logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。

• past_key_values (EncoderDecoderCache, optional, 当传入 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

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

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

• decoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

• cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

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

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

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

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

  要了解有关为预训练准备 input_ids 的更多信息，请参阅 UMT5 训练。

• attention_mask (torch.FloatTensor, shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1]：
  • 1 表示 未掩码 的 tokens，
  • 0 表示 被掩码 的 tokens。

  什么是注意力掩码？

• inputs_embeds (torch.FloatTensor, shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关的向量，则此选项很有用。
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个纯元组。

返回一个 BaseModelOutput 或一个元组（如果传入 return_dict=False 或当 config.return_dict=False 时，则为 torch.FloatTensor 元组），其中包含各种元素，具体取决于配置（UMT5Config）和输入。

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

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

  模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

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

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

参数

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

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

  什么是输入 ID？

  要了解有关为预训练准备 input_ids 的更多信息，请参阅 UMT5 训练。

• attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择自 [0, 1]:
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  什么是 attention masks?

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

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

  什么是 decoder input 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), 可选) — 默认行为：生成一个忽略 decoder_input_ids 中 padding token 的张量。默认情况下也会使用因果掩码。
• encoder_outputs (list, 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是 encoder 最后一层的输出 hidden-states 序列。用于 decoder 的 cross-attention。
• 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。

• labels (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels > 1，则会计算分类损失（交叉熵）。
• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回的张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关详细信息，请参阅返回的张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

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

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

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

• past_key_values (EncoderDecoderCache, optional, 当传入 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

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

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

• decoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

• cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

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

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

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

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

  什么是 input IDs?

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

• attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择自 [0, 1]:
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  什么是 attention masks?

• inputs_embeds (torch.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以通过直接传递嵌入表示来代替 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为相关向量有更多的控制，这将很有用。
• labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算 token 分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回的张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关详细信息，请参阅返回的张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

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

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

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

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

  模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

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

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

参数

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

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

  什么是 input IDs?

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

• attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择自 [0, 1]:
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  什么是 attention masks?

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

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

  什么是 decoder input 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), 可选) — 默认行为：生成一个忽略 decoder_input_ids 中 padding token 的张量。默认情况下也会使用因果掩码。
• encoder_outputs (tuple, 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是 encoder 最后一层的输出 hidden-states 序列。用于 decoder 的 cross-attention。
• start_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。计算损失时，序列外的那些位置不被考虑。
• end_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列长度（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, 可选) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回的张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关详细信息，请参阅返回的张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

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

• loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

• start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。

• end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。

• past_key_values (EncoderDecoderCache, optional, 当传入 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

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

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

• decoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

• cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

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

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), optional, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。