Transformers 文档
Gemma2
并获得增强的文档体验
开始使用
此模型于 2024-07-31 发布，并于 2024-06-27 添加到 Hugging Face Transformers。
Gemma2
Gemma 2 是一个语言模型家族，包含预训练和指令微调的变体，有 2B、9B、27B 参数版本。其架构与之前的 Gemma 类似，但增加了交错的局部注意力（4096 个 token）和全局注意力（8192 个 token），以及分组查询注意力（GQA），以提高推理性能。
2B 和 9B 模型采用知识蒸馏进行训练，指令微调变体则通过监督微调和强化学习进行后训练。
您可以在 Gemma 2 集合下找到所有原始 Gemma 2 检查点。
点击右侧边栏中的 Gemma 2 模型，了解更多关于如何将 Gemma 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline 或 AutoModel 类以及通过命令行与模型进行对话。
import torch
from transformers import pipeline
pipe = pipeline(
task="text-generation",
model="google/gemma-2-9b",
dtype=torch.bfloat16,
device_map="auto",
)
pipe("Explain quantum computing simply. ", max_new_tokens=50)量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
以下示例使用 bitsandbytes 将权重仅量化为 int4。
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
quantization_config = BitsAndBytesConfig(load_in_4bit=True)
tokenizer = AutoTokenizer.from_pretrained("google/gemma-2-27b")
model = AutoModelForCausalLM.from_pretrained(
"google/gemma-2-27b",
dtype=torch.bfloat16,
device_map="auto",
attn_implementation="sdpa"
)
input_text = "Explain quantum computing simply."
input_ids = tokenizer(input_text, return_tensors="pt").to(model.device)
outputs = model.generate(**input_ids, max_new_tokens=32, cache_implementation="static")
print(tokenizer.decode(outputs[0], skip_special_tokens=True))使用 AttentionMaskVisualizer 可以更好地了解模型可以关注哪些 token，不能关注哪些 token。
from transformers.utils.attention_visualizer import AttentionMaskVisualizer
visualizer = AttentionMaskVisualizer("google/gemma-2b")
visualizer("You are an assistant. Make sure you print me")
Gemma2Config
class transformers.Gemma2Config
< 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 use_bidirectional_attention: bool | None = None **kwargs )
参数
- vocab_size (
int, optional, defaults to 256000) — Gemma2 模型词汇量大小。定义了调用 Gemma2Model 时传递的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 decoder中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 8) — Transformer decoder中每个注意力层的注意力头数。 - num_key_value_heads (
int, optional, defaults to 4) — 这是实现分组查询注意力所需的 key_value 头数。如果num_key_value_heads=num_attention_heads，则模型将使用多头注意力（MHA）；如果num_key_value_heads=1，则模型将使用多查询注意力（MQA）；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头都应通过对组内的所有原始头进行平均池化来构建。更多详情，请参阅 这篇论文。如果未指定，则默认为num_attention_heads。 - head_dim (
int, optional, defaults to 256) — 注意力头的维度。 - hidden_activation (
str或function, 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 embedding 配置参数的字典。该字典应包含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) — 在 Gemma2 中，每隔一层使用滑动窗口注意力。这是滑动窗口的大小。 - 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 缩放因子。 - use_bidirectional_attention (
bool, optional) — 如果为 True，则模型将关注所有文本 token，而不是使用因果掩码。
这是用于存储 Gemma2Model 配置的配置类。它用于根据指定的参数实例化 Gemma2 模型，定义模型架构。使用默认值实例化一个配置将产生一个与 Gemma2-7B 类似的配置。例如 google/gemma2-7b。配置对象继承自 PreTrainedConfig，并可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
>>> from transformers import Gemma2Model, Gemma2Config
>>> # Initializing a Gemma2 gemma2-7b style configuration
>>> configuration = Gemma2Config()
>>> # Initializing a model from the gemma2-7b style configuration
>>> model = Gemma2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGemma2Model
class transformers.Gemma2Model
< source >( config: Gemma2Config )
参数
- config (Gemma2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化仅加载配置，不加载模型权重。请查看 from_pretrained() 方法来加载模型权重。
模型顶层没有任何特定头的 Gemma2 模型，输出原始隐藏状态。
此模型继承自 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 past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略 padding。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在 padding token 索引上进行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 **未被掩码** 的 token，
- 0 表示 **被掩码** 的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择在范围[0, config.n_positions - 1]内。 - 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（其 past key value 状态未提供给此模型的那些），其形状为(batch_size, unprocessed_length)，而不是所有input_ids，其形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵获得对input_ids索引转换为相关向量的更大控制，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则会返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受 padding 的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
根据配置（Gemma2Config）和输入，可能包含各种元素的 transformers.modeling_outputs.BaseModelOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding. -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Gemma2Model 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
Gemma2ForCausalLM
class transformers.Gemma2ForCausalLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (Gemma2ForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化仅加载配置，不加载模型权重。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Gemma2 模型。
此模型继承自 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 past_key_values: transformers.cache_utils.Cache | None = None 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.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略 padding。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在 padding token 索引上进行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 **未被掩码** 的 token，
- 0 表示 **被掩码** 的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择在范围[0, config.n_positions - 1]内。 - 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（其 past key value 状态未提供给此模型的那些），其形状为(batch_size, unprocessed_length)，而不是所有input_ids，其形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量的控制程度超过模型的内部嵌入查找矩阵，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]或 -100 (参见input_ids文档字符串) 范围内。索引设置为-100的标记将被忽略 (掩码)，损失仅为标签在[0, ..., config.vocab_size]范围内的标记计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码 (参见past_key_values)。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 描绘输入序列标记在序列中的位置的索引。与position_ids相反，该张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果是int，则计算最后logits_to_keep个标记的 logits。如果为0，则为所有input_ids计算 logits (特殊情况)。生成只需要最后一个标记的 logits，并且仅为该标记计算它们可以节省内存，这对于长序列或大词汇量来说非常显著。如果是一个torch.Tensor，它必须是 1D 的，对应于序列长度维度中要保留的索引。当使用打包张量格式 (批处理和序列长度的单个维度) 时，这很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个元组 torch.FloatTensor (如果传递了 return_dict=False 或当 config.return_dict=False 时) 包含各种元素，具体取决于配置 (Gemma2Config) 和输入。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Gemma2ForCausalLM 的 forward 方法会覆盖 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, Gemma2ForCausalLM
>>> model = Gemma2ForCausalLM.from_pretrained("google/gemma-2-9b")
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-2-9b")
>>> prompt = "What is your favorite condiment?"
>>> inputs = tokenizer(prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"What is your favorite condiment?"Gemma2ForSequenceClassification
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 防止对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 代表未被掩码的标记，
- 0 代表被掩码的标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 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)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量的控制程度超过模型的内部嵌入查找矩阵，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]或 -100 (参见input_ids文档字符串) 范围内。索引设置为-100的标记将被忽略 (掩码)，损失仅为标签在[0, ..., config.vocab_size]范围内的标记计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码 (参见past_key_values)。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.SequenceClassifierOutputWithPast or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The GenericForSequenceClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
Gemma2ForTokenClassification
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | 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) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 防止对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 代表未被掩码的标记，
- 0 代表被掩码的标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 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)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传递input_ids。如果您希望更精确地控制如何将input_ids索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，则此选项很有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]范围内，或为 -100（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），仅为标签在[0, ..., config.vocab_size]范围内的 token 计算损失。 - use_cache (
bool, optional) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The GenericForTokenClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。