Transformers 文档
RecurrentGemma
并获取增强的文档体验
开始使用
RecurrentGemma
概述
Recurrent Gemma 模型由 Google 的 Griffin、RLHF 和 Gemma 团队在 RecurrentGemma: Moving Past Transformers for Efficient Open Language Models 中提出。
该论文的摘要如下：
我们介绍了 RecurrentGemma，这是一个开放语言模型，它使用了 Google 创新的 Griffin 架构。Griffin 结合了线性循环和局部注意力机制，在语言任务上实现了卓越的性能。它具有固定大小的状态，从而减少了内存使用，并能够在长序列上进行高效的推理。我们提供了一个预训练模型，包含 2B 非嵌入参数，以及一个指令微调变体。尽管在更少的 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可以表示的不同 tokens 的数量。 - hidden_size (
int, 可选, 默认为 2560) — 隐藏层表示的维度。 - intermediate_size (
int, 可选, 默认为 7680) — MLP 表示的维度。 - num_attention_heads (
int, 可选, 默认为 10) — 注意力块的 head 数量，以及 RG-LRU 门控中使用的块对角线层的 head/block 数量。此数字必须能被hidden_size和lru_width整除。 - lru_width (
int或None, 可选) — RG-LRU 隐藏层表示的维度。如果为None，则将其设置为hidden_size。是否按sqrt(hidden_size)缩放 embeddings 的输出。 - attention_window_size (
int, 可选, 默认为 2048) — 注意力块中使用的注意力窗口大小。 - conv1d_width (
int, 可选, 默认为 4) — 循环块中使用的 conv1d 层的内核大小。 - logits_soft_cap (
float, 可选, 默认为 30.0) — 在因果 LM 架构中的 transformer 和 LM-head 计算之后，logits 应该被软上限的值。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的 key/values 注意力 (并非所有模型都使用)。仅当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) — 旋转 embeddings 初始化中使用的部分旋转因子。 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE embeddings 的基期。 - 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 heads 的数量。 - 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.configRecurrentGemma模型
class transformers.RecurrentGemmaModel
< source >( config: RecurrentGemmaConfig )
参数
- config (RecurrentGemmaConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
- config — RecurrentGemmaConfig
裸机 RecurrentGemma 模型，输出原始的隐藏状态，顶部没有任何特定的头部。此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。可将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是一个 RecurrentGemmaDecoderLayer
forward
< source >( input_ids: 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 )
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免在 padding 标记索引上执行 attention 的掩码。在[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_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列标记在序列中位置的索引。 与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新缓存并推断完整序列长度。
RecurrentGemmaModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
RecurrentGemmaForCausalLM
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)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免在 padding 标记索引上执行 attention 的掩码。在[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_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 详见返回张量下的hidden_states部分以获取更多细节。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是一个普通的元组。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 索引，描述输入序列 tokens 在序列中的位置。 与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新缓存，并推断完整的序列长度。 - labels (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 用于计算 masked language modeling loss 的标签。 索引应该在[0, ..., config.vocab_size]或 -100 之间（参见input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（masked），loss 仅针对标签在[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 (
torch.FloatTensor, 形状为(1,), 可选, 当提供labels时返回) — 语言建模损失 (用于下一个 token 预测)。 -
logits (
torch.FloatTensor, 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数 (每个词汇表 token 在 SoftMax 之前的分数)。 -
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 之后，用于计算自注意力头中的加权平均值。
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?"