Transformers 文档
T5Gemma
并获得增强的文档体验
开始使用
该模型于 2025-04-08 发布，并于 2025-06-25 添加到 Hugging Face Transformers。
T5Gemma
T5Gemma（又称 encoder-decoder Gemma）由 Google 在一篇研究论文中提出。它是一系列 encoder-decoder 大型语言模型，通过将预训练的 decoder-only 模型改编为 encoder-decoder 而开发。T5Gemma 包括预训练和指令微调的变体。该架构基于 transformer encoder-decoder 设计，遵循 T5，并引入了 Gemma 2 的改进：GQA、RoPE、GeGLU 激活、RMSNorm 以及交错的局部/全局注意力。
T5Gemma 有两类模型尺寸：1) Gemma 2 尺寸（2B-2B、9B-2B 和 9B-9B），基于官方 Gemma 2 模型（2B 和 9B）；2) T5 尺寸（Small、Base、Large 和 XL），它们在 Gemma 2 框架下按照 T5 配置进行了预训练。此外，我们还提供了一个 ML 尺寸（medium large，总计约 2B）的模型，介于 T5 Large 和 T5 XL 之间。
预训练变体通过两种目标进行训练：带知识蒸馏的前缀语言建模（PrefixLM）和 UL2。我们为每种模型尺寸发布了这两种变体。指令微调变体通过监督微调和强化学习进行了后训练。
点击右侧边栏的 T5Gemma 模型，了解更多关于如何将 T5Gemma 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline 或 AutoModel 类以及通过命令行与模型进行对话。
import torch
from transformers import pipeline
pipe = pipeline(
"text2text-generation",
model="google/t5gemma-2b-2b-prefixlm-it",
dtype=torch.bfloat16,
device_map="auto",
)
messages = [
{"role": "user", "content": "Tell me an unknown interesting biology fact about the brain."},
]
prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
pipe(prompt, max_new_tokens=32)T5GemmaConfig
class transformers.T5GemmaConfig
< source >( encoder: transformers.models.t5gemma.configuration_t5gemma.T5GemmaModuleConfig | dict[typing.Any, typing.Any] | None = None decoder: transformers.models.t5gemma.configuration_t5gemma.T5GemmaModuleConfig | dict[typing.Any, typing.Any] | None = None is_encoder_decoder: bool | None = True dropout_rate: float | None = 0.0 classifier_dropout_rate: float | None = 0.0 attention_dropout: float | None = 0.0 tie_word_embeddings: bool | None = True vocab_size: int | None = 256000 **kwargs )
参数
- encoder (
Union[T5GemmaModuleConfig, dict], optional, optional) — 配置编码器。 - decoder (
Union[T5GemmaModuleConfig, dict], optional, optional) — 配置解码器。 - is_encoder_decoder (bool, optional, optional, defaults to
True) — 模型是否用作 encoder/decoder。 - dropout_rate (
float, optional, defaults to 0.0) — 所有 dropout 层的比率（遵循 T5）。 - classifier_dropout_rate (
float, optional, defaults to 0.0) — 分类器的 dropout 比率（遵循 T5）。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力 dropout 比率。 - tie_word_embeddings (
bool, optional, defaults toTrue) — 是否绑定输入和输出嵌入。 - vocab_size (
int, optional, defaults to 256000) — T5Gemma 模型的词汇量大小（与 Gemma 2 相同）。 - kwargs (additional keyword arguments, optional, optional) — Will be passed to the PreTrainedConfig base class.
这是用于存储 T5GemmaModel 配置的类。它用于根据指定的参数实例化 T5Gemma 模型，定义模型架构。使用默认值实例化配置将产生一个与假定的平衡的 Gemma2 encoder-decoder 模型类似的配置。例如：google/t5gemma-2b-2b-prefixlm-it
配置对象继承自 [PreTrainedConfig]，可用于控制模型输出。有关更多信息，请阅读 [PreTrainedConfig] 的文档。T5GemmaModuleConfig
class transformers.T5GemmaModuleConfig
< source >( vocab_size: int | None = 256000 hidden_size: int | None = 2304 intermediate_size: int | None = 9216 num_hidden_layers: int | None = 26 num_attention_heads: int | None = 8 num_key_value_heads: int | None = 4 head_dim: int | None = 256 hidden_activation: str | None = 'gelu_pytorch_tanh' max_position_embeddings: int | None = 8192 initializer_range: float | None = 0.02 rms_norm_eps: int | None = 1e-06 use_cache: bool | None = True pad_token_id: int | None = 0 eos_token_id: int | None = 1 bos_token_id: int | None = 2 tie_word_embeddings: bool | None = True rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict[str, transformers.modeling_rope_utils.RopeParameters] | None = None attention_bias: bool | None = False attention_dropout: float | None = 0.0 query_pre_attn_scalar: int | None = 256 sliding_window: int | None = 4096 layer_types: list[str] | None = None final_logit_softcapping: float | None = 30.0 attn_logit_softcapping: float | None = 50.0 is_decoder: bool | None = False **kwargs )
参数
- vocab_size (
int, optional, defaults to 256000) — T5GemmaModule 模型的词汇量大小。定义了在调用T5GemmaModuleModel时传递的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, defaults to 2304) — 隐藏表示的维度。 - intermediate_size (
int, optional, defaults to 9216) — MLP 表示的维度。 - num_hidden_layers (
int, optional, defaults to 26) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 8) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, optional, defaults to 4) — 这是实现 Grouped Query Attention 所需的 key_value 头数。如果num_key_value_heads=num_attention_heads，模型将使用 Multi Head Attention (MHA)；如果num_key_value_heads=1，模型将使用 Multi Query Attention (MQA)；否则使用 GQA。在将 multi-head 检查点转换为 GQA 检查点时，每个组的 key 和 value 头应通过对该组内的所有原始头进行平均池化来构建。有关更多详细信息，请参阅本文档。如果未指定，则默认为num_attention_heads。 - head_dim (
int, optional, defaults to 256) — 注意力头的维度。 - hidden_activation (
strorfunction, optional, defaults to"gelu_pytorch_tanh") — 解码器中的非线性激活函数（函数或字符串）。如果未指定，则默认为"gelu_pytorch_tanh"。"gelu_pytorch_tanh"使用"gelu"激活函数的近似。 - max_position_embeddings (
int, optional, defaults to 8192) — 该模型可能处理的最大序列长度。 - initializer_range (
float, optional, defaults to 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, optional, defaults to 1e-06) — rms normalization 层使用的 epsilon。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后的 key/values attention（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - pad_token_id (
int, optional, defaults to 0) — 填充 token ID。 - eos_token_id (
int, optional, defaults to 1) — 流结束 token ID。 - bos_token_id (
int, optional, defaults to 2) — 流开始 token ID。 - tie_word_embeddings (
bool, optional, defaults toTrue) — 是否绑定词嵌入 - rope_parameters (
RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，并且可以选择用于缩放的参数，以防您想在更长的max_position_embeddings中使用 RoPE。 - attention_bias (
bool, defaults toFalse, optional, defaults toFalse) — 是否在自注意力中的查询、键、值和输出投影层使用偏置。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。 - query_pre_attn_scalar (
float, optional, defaults to 256) — 用于注意力分数上的缩放因子 - sliding_window (
int, optional, defaults to 4096) — 在 T5GemmaModule 中，每隔一层使用滑动窗口注意力。这是滑动窗口的大小。 - layer_types (
list, optional) — 每层的注意力模式。 - final_logit_softcapping (
float, optional, defaults to 30.0) — 应用 tanh softcapping 于 logits 时的缩放因子。 - attn_logit_softcapping (
float, optional, defaults to 50.0) — 应用 tanh softcapping 于注意力分数时的缩放因子。 - is_decoder (
bool, optional, defaults toFalse) — 是否仅使用编码器-解码器架构中的解码器，否则它对仅解码器或仅编码器架构没有影响。
这是存储 T5GemmaModuleModel 配置的配置类。它用于根据指定的参数实例化 T5GemmaModule 模型，定义模型架构。使用默认值实例化配置将得到与 T5GemmaModule-7B 类似的配置。例如：google/t5_gemma_module-7b 配置对象继承自 PreTrainedConfig，并可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
>>> from transformers import T5GemmaModuleModel, T5GemmaModuleConfig
>>> # Initializing a T5GemmaModule t5_gemma_module-7b style configuration
>>> configuration = T5GemmaModuleConfig()
>>> # Initializing a model from the t5_gemma_module-7b style configuration
>>> model = T5GemmaModuleModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configT5GemmaModel
class transformers.T5GemmaModel
< source >( config: T5GemmaConfig )
参数
- config (T5GemmaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
不带任何特定顶层的裸 T5Gemma 模型，输出原始隐藏状态。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None position_ids: torch.LongTensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.BoolTensor | None = None decoder_position_ids: torch.LongTensor | None = None encoder_outputs: transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.EncoderDecoderCache | None = None inputs_embeds: torch.Tensor | None = None decoder_inputs_embeds: torch.Tensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, shape(batch_size, sequence_length), optional) — 防止对填充 token 索引执行注意力的掩码。选择值在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - decoder_input_ids (
torch.LongTensor, shape(batch_size, target_sequence_length), optional) — 解码器输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- decoder_attention_mask (
torch.BoolTensor, shape(batch_size, target_sequence_length), optional) — 避免对某些 token 索引执行注意力的掩码。默认情况下，将使用因果掩码，以确保模型仅能查看先前输入的以预测未来。 - decoder_position_ids (
torch.LongTensor, shape(batch_size, decoder_sequence_length), optional) — 解码器输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.decoder.n_positions - 1]。 位置 ID 是什么？ - encoder_outputs (
~modeling_outputs.BaseModelOutput, optional) — 元组包含 (last_hidden_state, optional:hidden_states, optional:attentions) 形状为(batch_size, sequence_length, hidden_size)的last_hidden_state，optional，是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
~cache_utils.EncoderDecoderCache, optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的早期阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许输入 Cache 实例，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用
past_key_values，则用户需要只输入未处理的input_ids（即其过去的关键值状态未提供给此模型的那些），形状为(batch_size, unprocessed_length)，而不是所有input_ids，形状为(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）。 - cache_position (
torch.LongTensor, shape(sequence_length), optional) — 指示输入序列 token 在序列中的位置的索引。与position_ids不同，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）组成的，包含各种元素，具体取决于配置（T5GemmaConfig）和输入。
-
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 whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.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 之后，用于计算自注意力头中的加权平均。
T5GemmaModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
T5GemmaEncoderModel
class transformers.T5GemmaEncoderModel
< source >( config: T5GemmaConfig )
参数
- config (T5GemmaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
不带任何特定顶层的裸 T5Gemma 模型，输出原始隐藏状态。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望比模型内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将非常有用。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）组成的，包含各种元素，具体取决于配置（T5GemmaConfig）和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
T5GemmaEncoderModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
T5GemmaForConditionalGeneration
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None position_ids: torch.LongTensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.BoolTensor | None = None decoder_position_ids: torch.LongTensor | None = None encoder_outputs: transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.EncoderDecoderCache | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - decoder_input_ids (
torch.LongTensor, 形状为(batch_size, target_sequence_length), 可选) — 解码器输入序列 token 在词汇表中的索引。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- decoder_attention_mask (
torch.BoolTensor, 形状为(batch_size, target_sequence_length), 可选) — 用于避免在某些 token 索引上执行 attention 的掩码。默认情况下，将使用因果掩码，以确保模型只能查看之前的输入来预测未来。 - decoder_position_ids (
torch.LongTensor, 形状为(batch_size, decoder_sequence_length), 可选) — 解码器输入序列 token 在位置嵌入中的索引。选择范围为[0, config.decoder.n_positions - 1]。 什么是位置 ID？ - encoder_outputs (
~modeling_outputs.BaseModelOutput, 可选) — 由 (last_hidden_state, 可选:hidden_states, 可选:attentions) 组成的元组。last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层的隐藏状态序列。用于解码器的交叉 attention。 - past_key_values (
~cache_utils.EncoderDecoderCache, 可选) — 可用于加速顺序解码的预计算隐藏状态（自 attention 块和交叉 attention 块中的键和值）。这通常包括在解码的先前阶段由模型返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的 cache 格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（其 past key value 状态未传递给此模型的那些），形状为(batch_size, unprocessed_length)，而不是所有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。 - labels (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言模型损失的标签。索引应为[0, ..., config.vocab_size]或 -100（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失仅为具有标签[0, ..., config.vocab_size]的 token 计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受 padding 的影响。它用于在正确的位置更新 cache 并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 可选, 默认值0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果是0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量非常重要。如果是torch.Tensor，则必须是一维的，对应于要保留在序列长度维度上的索引。当使用打包的张量格式（批处理和序列长度的单维）时，这很有用。
返回
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.Seq2SeqLMOutput 或一个由 torch.FloatTensor 组成的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置（T5GemmaConfig）和输入。
-
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 whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.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 之后，用于计算自注意力头中的加权平均。
T5GemmaForConditionalGeneration 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
T5GemmaForSequenceClassification
class transformers.T5GemmaForSequenceClassification
< source >( config: T5GemmaConfig is_encoder_decoder: bool | None = None )
参数
- config (T5GemmaConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
- is_encoder_decoder (
Optional, 可选) — 是否为序列分类使用 encoder_decoder。设置为 False 时，仅使用 encoder。
在顶部带有序列分类/回归头的 T5Gemma 模型，例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.Tensor | None = None decoder_position_ids: torch.LongTensor | None = None encoder_outputs: transformers.modeling_outputs.BaseModelOutput | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 输入序列 token 在词汇表中的索引。默认情况下将忽略 padding。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。选择范围在[0, 1]：- 1 代表未掩码的 token，
- 0 代表已掩码的 token。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 输入序列 token 在位置嵌入中的索引。选择范围为[0, config.n_positions - 1]。 - decoder_input_ids (
torch.LongTensor, 形状为(batch_size, target_sequence_length), 可选) — 解码器输入序列 token 在词汇表中的索引。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- decoder_attention_mask (
torch.Tensor, 形状为(batch_size, target_sequence_length), 可选) — 用于避免在某些 token 索引上执行 attention 的掩码。默认情况下，将使用因果掩码，以确保模型只能查看之前的输入来预测未来。 - decoder_position_ids (
torch.LongTensor, 形状为(batch_size, decoder_sequence_length), 可选) — 解码器输入序列 token 在位置嵌入中的索引。选择范围为[0, config.decoder.n_positions - 1]。 什么是位置 ID？ - encoder_outputs (
~modeling_outputs.BaseModelOutput, optional) — 元组包含（last_hidden_state，可选：hidden_states，可选：attentions）last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中使用。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以通过传入嵌入表示来代替input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensorof 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.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.SequenceClassifierOutput 或元组torch.FloatTensor（如果传递了return_dict=False或当config.return_dict=False时），其中包含各种元素，具体取决于配置（T5GemmaConfig）和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
T5GemmaForSequenceClassification的forward方法重写了__call__特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, T5GemmaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
>>> model = T5GemmaForSequenceClassification.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = T5GemmaForSequenceClassification.from_pretrained("google/t5gemma-2b-2b-prefixlm-it", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, T5GemmaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
>>> model = T5GemmaForSequenceClassification.from_pretrained("google/t5gemma-2b-2b-prefixlm-it", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = T5GemmaForSequenceClassification.from_pretrained(
... "google/t5gemma-2b-2b-prefixlm-it", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossT5GemmaForTokenClassification
class transformers.T5GemmaForTokenClassification
< source >( config: T5GemmaConfig is_encoder_decoder: bool | None = None )
参数
- config (T5GemmaConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看from_pretrained()方法来加载模型权重。
- is_encoder_decoder (
Optional, optional) — 是否为token classification使用encoder_decoder。当设置为False时，只使用encoder。
一个在T5Gemma transformer之上的token classification head（一个位于隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.Tensor | None = None decoder_position_ids: torch.LongTensor | None = None encoder_outputs: transformers.modeling_outputs.BaseModelOutput | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列token的索引。默认情况下会忽略填充。可以使用AutoTokenizer获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充token索引执行注意力的掩码。选择值在[0, 1]中：- 1 表示未掩码的token，
- 0 表示已掩码的token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列token的位置索引。选择范围为[0, config.n_positions - 1]。 - decoder_input_ids (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) — 解码器输入序列token在词汇表中的索引。可以使用AutoTokenizer获取索引。有关详细信息，请参阅PreTrainedTokenizer.encode()和PreTrainedTokenizer.call()。
- decoder_attention_mask (
torch.Tensorof shape(batch_size, target_sequence_length), optional) — 避免对某些token索引执行注意力的掩码。默认情况下，将使用因果掩码，以确保模型只能查看前面的输入来预测未来。 - decoder_position_ids (
torch.LongTensorof shape(batch_size, decoder_sequence_length), optional) — 解码器输入序列token在位置嵌入中的位置索引。选择范围为[0, config.decoder.n_positions - 1]。什么是位置ID？ - encoder_outputs (
~modeling_outputs.BaseModelOutput, optional) — 元组包含（last_hidden_state，可选：hidden_states，可选：attentions）last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中使用。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以通过传入嵌入表示来代替input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensorof 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.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果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时），其中包含各种元素，具体取决于配置（T5GemmaConfig）和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
T5GemmaForTokenClassification的forward方法重写了__call__特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, T5GemmaForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
>>> model = T5GemmaForTokenClassification.from_pretrained("google/t5gemma-2b-2b-prefixlm-it")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...