Transformers 文档
RecurrentGemma
并获得增强的文档体验
开始使用
RecurrentGemma
概述
Recurrent Gemma 模型是由 Google 的 Griffin、RLHF 和 Gemma 团队在 RecurrentGemma: Moving Past Transformers for Efficient Open Language Models 中提出的。
论文摘要如下：
我们引入了 RecurrentGemma，这是一种使用 Google 创新的 Griffin 架构的开放语言模型。Griffin 结合了线性递归和局部注意力机制，在语言任务上实现了卓越的性能。它具有固定大小的状态，可减少内存使用并实现对长序列的高效推理。我们提供了一个预训练模型（20 亿非嵌入参数）和一个指令微调变体。尽管这些模型在较少的 tokens 上进行训练，但其性能与 Gemma-2B 相当。
技巧
- 原始检查点可以使用转换脚本
src/transformers/models/recurrent_gemma/convert_recurrent_gemma_weights_to_hf.py进行转换。
该模型由 Arthur Zucker 贡献。原始代码可在 此处 找到。
RecurrentGemmaConfig
class transformers.RecurrentGemmaConfig
< source >( num_hidden_layers = 26 vocab_size = 256000 hidden_size = 2560 intermediate_size = 7680 num_attention_heads = 10 lru_width = None attention_window_size = 2048 conv1d_width = 4 logits_soft_cap = 30.0 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 eos_token_id = 1 bos_token_id = 2 hidden_activation = 'gelu_pytorch_tanh' partial_rotary_factor = 0.5 rope_theta = 10000.0 block_types = ('recurrent', 'recurrent', 'attention') attention_dropout = 0.0 num_key_value_heads = None attention_bias = False w_init_variance_scale = 0.01 **kwargs )
参数
- num_hidden_layers (
int, 可选, 默认值为 26) — 模型中的隐藏层数量。 - vocab_size (
int, 可选, 默认值为 256000) — RecurrentGemma 模型的词汇表大小。定义了调用 RecurrentGemmaModel 时传入的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认值为 2560) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认值为 7680) — MLP 表示的维度。 - num_attention_heads (
int, 可选, 默认值为 10) — 注意力块中的头数量以及 RG-LRU 门中使用的块对角层中的头/块数量。此数字必须能整除hidden_size和lru_width。 - lru_width (
int或None, 可选) — RG-LRU 隐藏表示的维度。如果为None，则设置为hidden_size。是否通过sqrt(hidden_size)对嵌入的输出进行缩放。 - attention_window_size (
int, 可选, 默认值为 2048) — 注意力块中使用的注意力窗口大小。 - conv1d_width (
int, 可选, 默认值为 4) — 循环块中使用的 conv1d 层的核大小。 - logits_soft_cap (
float, 可选, 默认值为 30.0) — 在 Causal LM 架构中，变压器和 LM-head 计算后，logits 应该软上限的值。 - rms_norm_eps (
float, 可选, 默认值为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时才相关。 - pad_token_id (
int, 可选, 默认值为 0) — 填充 token ID。 - eos_token_id (
int, 可选, 默认值为 1) — 流结束 token ID。 - bos_token_id (
int, 可选, 默认值为 2) — 流开始 token ID。 - hidden_activation (
str` 或 `function, 可选, 默认值为"gelu_pytorch_tanh") — 循环块和解码器层 MLP 中使用的隐藏激活函数。 - partial_rotary_factor (
float, 可选, 默认值为 0.5) — 旋转嵌入初始化中使用的部分旋转因子。 - rope_theta (
float, 可选, 默认值为 10000.0) — RoPE 嵌入的基周期。 - block_types (
list[str], 可选, 默认值为('recurrent', 'recurrent', 'attention')) — 将重复以初始化temporal_block层的交替块列表。 - attention_dropout (
float, 可选, 默认值为 0.0) — 注意力 softmax 之后使用的 dropout 值。 - num_key_value_heads (
16, 可选, 默认值为 16) — 用于 GQA 的键值头数量。 - attention_bias (
bool, 可选, 默认值为False) — 注意力层的线性 q、k、v 是否应具有偏置。 - w_init_variance_scale (
float, 可选, 默认值为 0.01) — 权重初始化方差。
这是一个用于存储 RecurrentGemmaModel 配置的配置类。它用于根据指定的参数实例化 RecurrentGemma 模型，定义模型架构。使用默认值实例化配置将产生与 RecurrentGemma-7B 类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。
>>> from transformers import RecurrentGemmaModel, RecurrentGemmaConfig
>>> # Initializing a RecurrentGemma recurrentgemma-2b style configuration
>>> configuration = RecurrentGemmaConfig()
>>> # Initializing a model from the recurrentgemma-2b style configuration
>>> model = RecurrentGemmaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRecurrentGemmaModel
class transformers.RecurrentGemmaModel
< source >( config: RecurrentGemmaConfig )
参数
- config (RecurrentGemmaConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
裸露的 Recurrent Gemma 模型，直接输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。查阅超类文档以了解库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None cache_position: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithNoAttention 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免对填充 token 索引执行注意力操作。遮罩值选择范围为[0, 1]：- 1 表示未遮罩的 token，
- 0 表示已遮罩的 token。
- cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 序列中输入序列 token 位置的索引。与position_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_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithNoAttention 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithNoAttention 或一个 torch.FloatTensor 的元组（如果传入了 return_dict=False 或 config.return_dict=False），包含根据配置 (RecurrentGemmaConfig) 和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, num_channels, height, width)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出（如果模型有嵌入层），加上每个层的输出），形状为(batch_size, num_channels, height, width)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
RecurrentGemmaModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应调用 Module 实例而不是该函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。
RecurrentGemmaForCausalLM
class transformers.RecurrentGemmaForCausalLM
< source >( config )
参数
- config (RecurrentGemmaForCausalLM) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Recurrent Gemma 模型。
此模型继承自 PreTrainedModel。查阅超类文档以了解库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None cache_position: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None use_cache: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 序列中输入序列 token 位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免对填充 token 索引执行注意力操作。遮罩值选择范围为[0, 1]：- 1 表示未遮罩的 token，
- 0 表示已遮罩的 token。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）不传入input_ids，而是直接传入嵌入表示。如果你想更精细地控制如何将input_ids索引转换为关联向量，而不是使用模型内部的嵌入查找矩阵，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算遮罩语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（遮罩），损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutput 或一个 torch.FloatTensor 的元组（如果传入了 return_dict=False 或 config.return_dict=False），包含根据配置 (RecurrentGemmaConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
RecurrentGemmaForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应调用 Module 实例而不是该函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。
示例
>>> from transformers import AutoTokenizer, RecurrentGemmaForCausalLM
>>> model = RecurrentGemmaForCausalLM.from_pretrained("google/recurrentgemma-2b")
>>> tokenizer = AutoTokenizer.from_pretrained("google/recurrentgemma-2b")
>>> 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?"