Transformers 文档
VaultGemma
并获得增强的文档体验
开始使用
该模型于 2016-07-01 发布，并于 2025-09-12 添加到 Hugging Face Transformers。
VaultGemma
概述
VaultGemma 是一个纯文本解码器模型，源自 Gemma 2。它删除了 Attention 和 MLP 块之后的 norm 层，并且所有层都使用全注意力机制，而不是全注意力与局部滑动注意力交替使用。VaultGemma 可作为一个具有 1B 参数、使用 1024 token 序列长度的预训练模型提供。
VaultGemma 是从头开始使用序列级差分隐私 (DP) 进行训练的。其训练数据包含与 Gemma 2 模型相同的混合数据，包括不同长度的文档。此外，它使用 DP 随机梯度下降 (DP-SGD) 进行训练，并提供 (ε ≤ 2.0, δ ≤ 1.1e-10) 的序列级 DP 保证，其中序列由从异构数据源提取的 1024 个连续 token 组成。具体来说，该保证的隐私单元是指混合数据采样和打包后的序列。
单击右侧边栏中的 VaultGemma 模型，了解更多将 VaultGemma 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 类或从命令行与模型进行聊天。
from transformers import pipeline
pipe = pipeline(
task="text-generation",
model="google/vaultgemma-1b",
dtype="auto",
device_map="auto",
)
text = "Tell me an unknown interesting biology fact about the brain."
outputs = pipe(text, max_new_tokens=32)
response = outputs[0]["generated_text"]
print(response)VaultGemmaConfig
class transformers.VaultGemmaConfig
< 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 **kwargs )
参数
- vocab_size (
int, optional, defaults to 256000) — VaultGemma 模型的词汇量。定义了调用 VaultGemmaModel 时传入的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。在将多头检查点转换为 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) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - rms_norm_eps (
float, optional, defaults to 1e-06) — rms 归一化层使用的 epsilon。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应该返回最后一个 key/values 注意力（并非所有模型都使用）。仅当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更长时进行缩放的可选参数。 - 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) — 在 VaultGemma 中，每隔一层使用滑动窗口注意力。这是滑动窗口的大小。 - 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 到注意力分数时的缩放因子。
这是存储 VaultGemmaModel 配置的配置类。它用于根据指定的参数实例化一个 VaultGemma 模型，定义模型的架构。使用默认值实例化一个配置将产生一个与 VaultGemma-7B 相似的配置。例如 google/vaultgemma-7b。配置对象继承自 PreTrainedConfig，并可用于控制模型的输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
>>> from transformers import VaultGemmaModel, VaultGemmaConfig
>>> # Initializing a VaultGemma vaultgemma-7b style configuration
>>> configuration = VaultGemmaConfig()
>>> # Initializing a model from the vaultgemma-7b style configuration
>>> model = VaultGemmaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configVaultGemmaModel
class transformers.VaultGemmaModel
< source >( config: VaultGemmaConfig )
参数
- config (VaultGemmaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
模型顶层没有任何特定头部的、输出原始隐藏状态的裸 Vaultgemma 模型。
此模型继承自 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.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在[0, 1]：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列 token 在位置嵌入中的索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自 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索引转换为相关的向量，这会很有用。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新 cache 并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置（VaultGemmaConfig）和输入而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
VaultGemmaModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
VaultGemmaForCausalLM
class transformers.VaultGemmaForCausalLM
< 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 (VaultGemmaForCausalLM) — 模型配置类，包含模型的全部参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 VaultGemma 模型。
此模型继承自 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.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在[0, 1]：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列 token 在位置嵌入中的索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自 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索引转换为相关的向量，这会很有用。 - 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，并且仅为该标记计算 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 时），其中包含各种元素，具体取决于配置（VaultGemmaConfig）和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
VaultGemmaForCausalLM 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, VaultGemmaForCausalLM
>>> model = VaultGemmaForCausalLM.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?"