RecurrentGemma
概述
Recurrent Gemma 模型由谷歌的Griffin、RLHF和Gemma团队在《RecurrentGemma: Moving Past Transformers for Efficient Open Language Models》中提出，该论文可通过以下链接获取：RecurrentGemma: Moving Past Transformers for Efficient Open Language Models。
论文摘要如下
我们介绍了RecurrentGemma，一个开源语言模型，该模型采用谷歌的新型Griffin架构。Griffin结合了线性递归和局部注意力，在语言任务上取得了优异的性能。它具有固定大小的状态，这减少了内存使用并使得在长序列上进行高效推理成为可能。我们提供了一个具有20亿非嵌入参数的预训练模型和一个指令调整变体。这两个模型在训练用词 fewer单位的条件下，仍然达到了与Gemma-2B可比的性能。
提示
此模型由 Arthur Zucker 贡献。原始代码可在此处找到。
RecurrentGemmaConfig
类 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可以表示的不同标记的数量。 - 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) — 在因果 LM 架构中 Transformer 和 LM 头计算后 logits 应该软限制的值。 - 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。 - 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 (布尔值, 可选, 默认为
False) — 是否在 Attention 层的线性 q,k,v 中有偏差 - — 权重初始化方差.
这是一个配置类，用于存储 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
类 transformers.RecurrentGemmaModel
< 来源 >( 配置: RecurrentGemmaConfig )
参数
- 配置 （RecurrentGemmaConfig） — 模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。配置 — RecurrentGemmaConfig
仅输出原始隐藏状态的裸RecurrentGemma模型，顶部没有任何特定头。此模型继承自PreTrainedModel。查看超类文档了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入的大小、修剪头等）
此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块，并查阅PyTorch文档了解所有有关通用用法和行为的内容。
Transformer解码器由config.num_hidden_layers层组成。每层都是嵌套的RecurrentGemmaDecoderLayer
forward
< 来源 >( 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 (
torch.LongTensorof shape(batch_size, sequence_length)) — 词库中输入序列标记的索引。如果提供，则默认忽略填充。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于防止在填充标记索引上执行注意力的掩码。掩码值选在[0, 1]范围内：- 1：表示未遮罩的标记,
- 0：表示遮罩的标记。
可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensor的形状为(batch_size, sequence_length)，可选 ) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size)，可选 ) — 可选地，而不是传递input_ids，您可以选择直接传递嵌入表示。如果您希望比模型内部嵌入查找矩阵有更多控制权，将input_ids索引转换为相关向量的方式，这将很有用。 - use_cache (
bool，可选 ) — 如果设置为True，返回past_key_valueskey value 状态，并且可以用来自加速解析（见past_key_values）。 - output_hidden_states (
bool, 可选) — 是否返回所有隐藏状态。详见返回张量下的hidden_states了解更多详情。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 表示输入序列标记在序列中的位置的索引。与position_ids不同，此张量不受填充的影响。它用于在正确位置更新缓存并推断完整的序列长度。
RecurrentGemmaModel的前向方法，重写了__call__特殊方法。
尽管前向传递的配方需要在函数内部定义，但应该调用之后的Module实例，而不是这个，因为前者负责运行前置和后置处理步骤，而后者会静默忽略它们。
RecurrentGemmaForCausalLM
forward
< 来源 >( input_ids: 可选 = None cache_position: 可选 = None attention_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None use_cache: 可选 = None ) → transformers.modeling_outputs.CausalLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下，如果提供了填充项，将会忽略填充项。可以使用 AutoTokenizer 来获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(批量大小, 序列长度)，可选) — 避免在填充词索引上执行注意力操作的遮罩。遮罩值选择在[0, 1]区间内：- 1 表示 未遮罩 的标记；
- 0 表示 遮罩 的标记。
索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensor形状为(批量大小, 序列长度)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - 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, optional) — 是否返回ModelOutput而不是普通的元组。 - cache_position (
torch.LongTensor，shape为(sequence_length)，optional) — 表示输入序列标记在序列中的位置的索引。与position_ids不同，这个张量不受填充的影响。它用于在正确的位置更新缓存，并推断完整序列长度。参数 — labels (
torch.LongTensor，shape为(batch_size, sequence_length)，optional)：用于计算掩码语言模型损失的标签。索引可以是[0, ..., config.vocab_size]或-100（参见input_ids文档字符串）。设置索引为-100的标记将被忽略（遮蔽），只对标记的标记计算损失，《code>0, ..., config.vocab_size。
一个 transformers.modeling_outputs.CausalLMOutput 或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时），包含根据配置（RecurrentGemmaConfig）和输入而定的各种元素。
-
loss (
torch.FloatTensor，shape为(1,)，optional，当提供labels时返回) — 语言模型损失（用于下一标记的预测）。 -
logits (
torch.FloatTensor，shape为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax之前每个词汇表的分数）。 -
hidden_states (
tuple(torch.FloatTensor)，optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个torch.FloatTensor的元组（如果模型有嵌入层，则包括嵌入的输出，然后是每层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型的每个输出层的隐藏状态加上可选的初始嵌入输出。
-
注意事项 (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的每个分层一个的torch.FloatTensor组成的元组。在注意力软最大化后的注意力权重，用于计算自注意力头中的加权平均。
RecurrentGemmaForCausalLM 前向方法，重写了 __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?"