Transformers 文档
RecurrentGemma
并获得增强的文档体验
开始使用
该模型于 2024-04-11 发布，并于 2024-04-10 添加到 Hugging Face Transformers。
RecurrentGemma
概述
Recurrent Gemma 模型由 Google 的 Griffin、RLHF 和 Gemma 团队在 RecurrentGemma: Moving Past Transformers for Efficient Open Language Models 中提出。
论文摘要如下：
我们提出了 RecurrentGemma，一个使用了 Google 新型 Griffin 架构的开放语言模型。Griffin 将线性递归与局部注意力相结合，在语言任务上取得了优异的性能。它具有固定大小的状态，从而减少了内存使用并实现了长序列的高效推理。我们提供了一个具有 2B 非嵌入参数的预训练模型和一个经过指令微调的变体。尽管这两个模型在更少的 token 上进行了训练，但它们的性能与 Gemma-2B 相当。
技巧
- 原始的检查点可以使用转换脚本
src/transformers/models/recurrent_gemma/convert_recurrent_gemma_weights_to_hf.py进行转换。
此模型由 Arthur Zucker 贡献。原始代码可以在 此处找到。
RecurrentGemmaConfig
class transformers.RecurrentGemmaConfig
< source >( num_hidden_layers: int | None = 26 vocab_size: int | None = 256000 hidden_size: int | None = 2560 intermediate_size: int | None = 7680 num_attention_heads: int | None = 10 lru_width: int | None = None attention_window_size: int | None = 2048 conv1d_width: int | None = 4 logits_soft_cap: float | None = 30.0 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 hidden_activation: str | None = 'gelu_pytorch_tanh' rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict[str, transformers.modeling_rope_utils.RopeParameters] | None = None block_types: list[str] | None = ('recurrent', 'recurrent', 'attention') attention_dropout: float | None = 0.0 num_key_value_heads: int | None = None attention_bias: str | None = False w_init_variance_scale: float | None = 0.01 tie_word_embeddings: bool | None = True **kwargs )
参数
- num_hidden_layers (
int, optional, defaults to 26) — 模型的隐藏层数量。 - vocab_size (
int, optional, defaults to 256000) — RecurrentGemma 模型词汇表大小。定义了调用 RecurrentGemmaModel 时传入的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, defaults to 2560) — 隐藏表示的维度。 - intermediate_size (
int, optional, defaults to 7680) — MLP 表示的维度。 - num_attention_heads (
int, optional, defaults to 10) — 注意力块的数量以及 RG-LRU 门中使用的块对角线层的头数/块数。此数字必须能整除hidden_size和lru_width。 - lru_width (
int或None, optional) — RG-LRU 的隐藏表示维度。如果为None，则将其设置为hidden_size。是否将 embedding 的输出按sqrt(hidden_size)进行缩放。 - attention_window_size (
int, optional, defaults to 2048) — 注意力块中使用的注意力窗口大小。 - conv1d_width (
int, optional, defaults to 4) — 递归块中使用的 conv1d 层的核大小。 - logits_soft_cap (
float, optional, defaults to 30.0) — 在因果 LM 架构中，经过 transformer 和 LM-head 计算后，logits 应软限制到的值。 - rms_norm_eps (
float, optional, defaults to 1e-06) — rms normalization 层使用的 epsilon。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当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。 - hidden_activation (
str` 或 `function, optional, defaults to"gelu_pytorch_tanh") — 递归块以及解码器层 MLP 中使用的隐藏激活。 - rope_parameters (
RopeParameters, optional) — 包含 RoPE embedding 配置参数的字典。字典应包含rope_theta的值，以及可选的用于扩展max_position_embeddings的缩放参数。 - block_types (
list[str], optional, defaults to('recurrent', 'recurrent', 'attention')) — 初始化temporal_block层的交替块列表。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力 softmax 之后使用的 dropout 值。 - num_key_value_heads (
16, optional, defaults to 16) — 用于 GQA 的键值头数。 - attention_bias (
bool, optional, defaults toFalse) — 注意力层的线性 q,k,v 是否应具有偏置。 - w_init_variance_scale (
float, optional, defaults to 0.01) — 权重初始化方差。 - tie_word_embeddings (
bool, optional, defaults toTrue) — 是否绑定词嵌入。
这是用于存储 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) — 模型配置类，包含模型的所有参数。使用 config 文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bare Recurrent Gemma 模型，输出原始隐藏状态，顶部没有任何特定头。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None cache_position: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithNoAttention 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 tokens 在词汇表中的索引。默认情况下，填充会被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 tokens 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值选择在[0, 1]之间：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- cache_position (
torch.LongTensorof shape(sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整序列长度。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，除了传递input_ids之外，您还可以选择直接传递嵌入表示。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为相关的向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithNoAttention 或 tuple(torch.FloatTensor)
根据配置 (RecurrentGemmaConfig) 和输入，返回一个 transformers.modeling_outputs.BaseModelOutputWithNoAttention 或 torch.FloatTensor 的元组（如果传入了 return_dict=False 或 config.return_dict=False）。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, num_channels, height, width)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则包含一个嵌入层输出，加上每层的一个输出），形状为(batch_size, num_channels, height, width)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
transformers.RecurrentGemmaModel 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
RecurrentGemmaForCausalLM
class transformers.RecurrentGemmaForCausalLM
< 源代码 >( 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 (RecurrentGemmaForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化仅加载配置，不加载模型相关的权重。请查看 from_pretrained() 方法加载模型权重。
用于因果语言建模的 Recurrent Gemma 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None cache_position: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_hidden_states: bool | None = None return_dict: bool | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 tokens 在词汇表中的索引。默认情况下，填充会被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 tokens 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整序列长度。 - attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值选择在[0, 1]之间：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，除了传递input_ids之外，您还可以选择直接传递嵌入表示。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为相关的向量，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100（请参阅input_ids文档字符串）之间。索引设置为-100的 token 将被忽略（掩码），损失仅为标签在[0, ..., config.vocab_size]范围内的 token 计算。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，并且仅为该 token 计算可以节省内存，这对于长序列或大词汇量非常重要。如果是torch.Tensor，则必须是一维的，对应于序列长度维度中的索引。这在使用打包张量格式时很有用（批次和序列长度的单维）。
返回
transformers.modeling_outputs.CausalLMOutput or 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), 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 后的注意力权重，用于计算自注意力头中的加权平均值。
RecurrentGemmaForCausalLM 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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?"