Gemma2
概述
Gemma2 模型由 Google 的 Gemma2 团队在 Gemma2: 基于 Gemini 技术和研究的开放模型 中提出。发布了两个 Gemma2 模型，参数规模分别为 90 亿 (9B) 和 270 亿 (27B)。
博客文章的摘要如下：
我们现在正式向全球的研究人员和开发者发布 Gemma 2。Gemma 2 有 90 亿 (9B) 和 270 亿 (27B) 两种参数规模，与第一代相比，Gemma 2 的性能更高，推理效率更高，并且内置了重大的安全改进。事实上，在 27B 的规模下，它提供了与规模大它两倍的模型相比的竞争性替代方案，实现了在最近的 12 月之前只有专有模型才能实现的性能。
提示
- 可以使用转换脚本
src/transformers/models/Gemma2/convert_Gemma2_weights_to_hf.py转换原始检查点。
- Gemma2 每隔一层使用滑动窗口注意力，这使得它不适合使用 ~DynamicCache 或张量元组进行典型的 kv 缓存。为了在 Gemma2 前向调用中启用缓存，您必须初始化 ~HybridCache 实例并将其作为
past_key_values传递给前向调用。请注意，如果您past_key_values中已经包含先前键值，则您还需要准备cache_position。
该模型由 Arthur Zucker、Pedro Cuenca 和 Tom Arsen 贡献。
Gemma2Config
class transformers.Gemma2Config
< 源代码 >( vocab_size = 256000 hidden_size = 3072 intermediate_size = 24576 num_hidden_layers = 28 num_attention_heads = 16 num_key_value_heads = 16 head_dim = 256 hidden_activation = 'gelu_pytorch_tanh' max_position_embeddings = 8192 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 eos_token_id = 1 bos_token_id = 2 tie_word_embeddings = True rope_theta = 10000.0 attention_bias = False attention_dropout = 0.0 query_pre_attn_scalar = 224 sliding_window = 4096 final_logit_softcapping = 30.0 attn_logit_softcapping = 50.0 cache_implementation = 'hybrid' **kwargs )
参数
- vocab_size (
int, 可选, 默认值 256000) — Gemma2 模型的词汇量大小。定义了调用 Gemma2Model 时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认值 3072) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认值 24576) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认值 28) — Transformer 解码器中的隐藏层数。 - num
- num_key_value_heads (
int, 可选, 默认为 16) — 用于实现分组查询注意力的 key_value 头数。 如果num_key_value_heads=num_attention_heads，模型将使用多头注意力 (MHA)，如果num_key_value_heads=1模型将使用多查询注意力 (MQA)，否则将使用 GQA。 在将多头检查点转换为 GQA 检查点时，应通过对该组中所有原始头的平均池化来构建每个组的键和值头。 有关更多详细信息，请查看 这篇论文。 如果未指定，将默认为num_attention_heads。 - head_dim (
int, 可选, 默认为 256) — 注意力头维度。 - hidden_activation (
str或function, 可选, 默认为"gelu_pytorch_tanh") — 解码器中的非线性激活函数（函数或字符串）。 如果未指定，将默认为"gelu_pytorch_tanh"。"gelu_pytorch_tanh"使用"gelu"激活函数的近似值。 - max_position_embeddings (
int, 可选, 默认为 8192) — 该模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。 仅在config.is_decoder=True时相关。 - pad_token_id (
int, 可选, 默认为 0) — 填充标记 ID。 - eos_token_id (
int, 可选, 默认为 1) — 流结束标记 ID。 - bos_token_id (
int, 可选, 默认为 2) — 流开始标记 ID。 - attention_bias (
bool, 默认为False, 可选, 默认为False) — 是否在自注意力期间在查询、键、值和输出投影层中使用偏差。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意概率的丢弃率。 - query_pre_attn_scalar (
float, 可选, 默认为 224) — 用于注意力分数的缩放因子 - sliding_window (
int, 可选, 默认为 4096) — 在 Gemma2 中，每隔一层使用滑动窗口注意力。 这是滑动窗口的大小。 - final_logit_softcapping (
float, 可选, 默认为 30.0) — 对 logits 应用 tanh 软帽时使用的缩放因子。 - attn_logit_softcapping (
float, 可选, 默认为 50.0) — 对注意力分数应用 tanh 软帽时使用的缩放因子。 - cache_implementation (
str, 可选, 默认为"hybrid") — 要与generate一起使用的缓存类型。
这是用于存储 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 )
Gemma2ForCausalLM
前向
< 源代码 >( input_ids: LongTensor = None attention_mask: 可选 = None position_ids: 可选 = None past_key_values: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None cache_position: 可选 = None num_logits_to_keep: int = 0 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供它，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示未被屏蔽的 token，
- 0 表示被屏蔽的 token。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个input_ids（请参见past_key_values）。如果你想更改填充行为，你应该阅读
modeling_opt._prepare_decoder_attention_mask并根据你的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示头部未被屏蔽，
- 0 表示头部被屏蔽。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列 token 在位置嵌入中的位置索引。选择在[0, config.n_positions - 1]范围内。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含在模型在解码的先前阶段返回的past_key_values中，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统的缓存格式。
模型将输出与作为输入馈送的相同缓存格式。如果没有传递
past_key_values，则将返回传统的缓存格式。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有将它们过去的键值状态提供给此模型的），而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，而不是传递input_ids，你可以选择直接传递嵌入表示。如果你想对如何将input_ids索引转换为相关的向量（比模型的内部嵌入查找矩阵更灵活）进行更多控制，这将很有用。 - 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)，可选) — 表示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选): 用于计算掩蔽语言建模损失的标签。索引应为[0, ..., config.vocab_size]或 -100 (参见input_ids文档字符串)。索引设置为-100的标记将被忽略（掩蔽），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。num_logits_to_keep (
int，可选): 计算最后num_logits_to_keep个标记的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成只需要最后一个标记的 logits，并且仅针对该标记计算它们可以节省内存，这对长序列或大型词汇表大小来说非常重要。
返回值
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (Gemma2Config) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇表标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加快顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。自注意力头中用于计算加权平均值的注意力 softmax 之后的注意力权重。
The Gemma2ForCausalLM 正向方法，覆盖 __call__ 特殊方法。
尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则默默地忽略它们。
例子
>>> from transformers import AutoTokenizer, GemmaForCausalLM
>>> model = GemmaForCausalLM.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
class transformers.Gemma2ForSequenceClassification
< source >( config )
参数
- config (Gemma2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
Gemma2 模型转换器，顶部带有序列分类头（线性层）。
Gemma2ForSequenceClassification 使用最后一个标记进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个标记进行分类，因此它需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果未定义 pad_token_id，它只会简单地获取批次中每行的最后一个值。由于它在传递 inputs_embeds 而不是 input_ids 时无法猜测填充标记，因此它会执行相同的操作（获取批次中每行的最后一个值）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
前向
< source >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 代表 **未被掩盖** 的标记
- 0 代表 **被掩盖** 的标记
索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择只输入最后一个input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需求进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示头 **未被掩盖**
- 0 表示头 **被掩盖**
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有传递给该模型的过去键值状态的input_ids），形状为(batch_size, 1)，而不是所有input_ids，形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 选择性地，而不是传递input_ids，您可以选择直接传递嵌入表示。如果您希望对如何将input_ids索引转换为关联向量（比模型内部嵌入查找矩阵更精细）有更多控制，这将很有用。 - 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)，可选) — 表示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]中。 如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
The Gemma2ForSequenceClassification forward method, overrides the __call__ special method.
尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则默默地忽略它们。
Gemma2ForTokenClassification
class transformers.Gemma2ForTokenClassification
< source >( config )
参数
- config (Gemma2Config) — 模型配置类，包含模型的所有参数。 使用配置文件进行初始化不会加载与模型相关的权重，仅加载配置。 请查看 from_pretrained() 方法来加载模型权重。
Gemma2 模型转换器，在其顶部有一个标记分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
前向
< source >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。 如果您提供它，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意的掩码。 在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个input_ids（请参阅past_key_values）。如果要更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图表 1。- 1 表示头未掩码，
- 0 表示头掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。 从[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统的缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，则将返回传统的缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有为该模型提供过去键值状态的input_ids），而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）进行更多控制，这将很有用。 - 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 (形状为
(sequence_length)的torch.LongTensor, 可选) — 指示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
该 Gemma2ForTokenClassification 正向方法覆盖了 __call__ 特殊方法。
尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则默默地忽略它们。