RecurrentGemma
概述
Recurrent Gemma 模型在以下论文中提出： RecurrentGemma: Moving Past Transformers for Efficient Open Language Models 由 Google 的 Griffin、RLHF 和 Gemma 团队提出。
论文摘要如下：
我们介绍了 RecurrentGemma，这是一个开放语言模型，它使用了 Google 新颖的 Griffin 架构。Griffin 结合了线性递归和局部注意力，在语言方面取得了出色的性能。它具有固定大小的状态，减少了内存使用，并能够在长序列上进行高效的推理。我们提供了一个具有 20 亿非嵌入参数的预训练模型，以及一个指令调优的变体。尽管在较少的 tokens 上训练，但这两个模型都取得了与 Gemma-2B 相当的性能。
提示
- 原始检查点可以使用转换脚本进行转换：
src/transformers/models/recurrent_gemma/convert_recurrent_gemma_weights_to_hf.py。
此模型由 Arthur Zucker 贡献。原始代码可以在以下位置找到： here。
RecurrentGemmaConfig
class transformers.RecurrentGemmaConfig
< 源代码 >( 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) — 注意力模块的 head 数量以及 RG-LRU 门控中使用的块对角层（block-diagonal layers）的 head/块数量。 这个数字必须能被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 架构中，transformer 和 LM-head 计算之后，logits 应该被软上限（soft-capped）的值。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的 key/value 注意力（并非所有模型都使用）。 仅当config.is_decoder=True时相关。 - pad_token_id (
int, 可选, 默认为 0) — Padding 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) — 在 rotary 嵌入初始化中使用的 partial rotary factor。 - 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 的 key value head 数量。 - attention_bias (
bool, 可选, 默认为False) — Attention 层的线性 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
< 源码 >( config: RecurrentGemmaConfig )
参数
- config (RecurrentGemmaConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。 config — RecurrentGemmaConfig
输出原始隐藏状态且顶部没有任何特定 head 的裸 RecurrentGemma 模型。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 的子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
由 config.num_hidden_layers 层组成的 Transformer 解码器。 每层都是一个 RecurrentGemmaDecoderLayer
前向
< 源码 >( input_ids: LongTensor = None position_ids: Optional = None attention_mask: Optional = None cache_position: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供 padding，则会被忽略。索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 tokens，
- 0 表示 被掩码 的 tokens。
索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列 token 在位置 embeddings 中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 索引，描述输入序列 tokens 在序列中的位置。与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新 cache 并推断完整的序列长度。
RecurrentGemmaModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
RecurrentGemmaForCausalLM
前向
< source >( input_ids: Optional = None position_ids: Optional = None cache_position: Optional = None attention_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None use_cache: Optional = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供 padding，则会被忽略。索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 tokens，
- 0 表示 被掩码 的 tokens。
索引可以使用 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列 token 在位置 embeddings 中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 索引，描述输入序列 tokens 在序列中的位置。与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新 cache 并推断完整的序列长度。Args — labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选): 用于计算 masked language modeling 损失的标签。索引应为[0, ..., config.vocab_size]或 -100（请参阅input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。
返回值
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.CausalLMOutput 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (RecurrentGemmaConfig) 和输入。
-
loss (形状为
(1,)的torch.FloatTensor, 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型具有 embedding 层，则为 embedding 输出，每个层的输出各一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算自注意力头中的加权平均值。
RecurrentGemmaForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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?"