Transformers 文档

循环宝石

RecurrentGemma

概述

Recurrent Gemma 模型由 Google 的 Griffin、RLHF 和 Gemma 团队在 RecurrentGemma: Moving Past Transformers for Efficient Open Language Models 中提出。

论文的摘要如下:

我们介绍了RecurrentGemma,这是一个使用谷歌新颖的Griffin架构的开放语言模型。Griffin结合了线性递归和局部注意力,在语言上实现了卓越的性能。它具有固定大小的状态,这减少了内存使用并能够在长序列上高效推理。我们提供了一个具有20亿非嵌入参数的预训练模型,以及一个经过指令调优的变体。尽管在较少的token上进行了训练,这两个模型都实现了与Gemma-2B相当的性能。

提示:

该模型由Arthur Zucker贡献。原始代码可以在这里找到。

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 表示的不同令牌的数量
  • hidden_size (int, optional, 默认为 2560) — 隐藏表示的维度。
  • intermediate_size (int, optional, 默认为 7680) — MLP 表示的维度。
  • num_attention_heads (int, 可选, 默认为 10) — 注意力块的头数以及RG-LRU门中使用的块对角层的头数/块数。 这个数字必须能整除 hidden_sizelru_width.
  • lru_width (intNone, 可选) — RG-LRU 隐藏表示的维度。如果为 None, 则将其设置为 hidden_size。 是否通过 sqrt(hidden_size) 缩放嵌入的输出。
  • attention_window_size (int, 可选, 默认为 2048) — 用于注意力块中的注意力窗口的大小。
  • conv1d_width (int, 可选, 默认为 4) — 用于循环块中的 conv1d 层的核大小。
  • logits_soft_cap (float, optional, 默认为 30.0) — 在因果语言模型架构中,经过transformer和LM-head计算后,logits应该被软限制的值。
  • rms_norm_eps (float, optional, defaults to 1e-06) — rms归一化层使用的epsilon值。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅在 config.is_decoder=True 时相关。
  • pad_token_id (int, optional, 默认为 0) — 填充标记的id.
  • eos_token_id (int, optional, 默认为 1) — 流结束标记的ID.
  • bos_token_id (int, optional, 默认为 2) — 流的开始标记 id.
  • hidden_activation (str` or `function, 可选, 默认为 "gelu_pytorch_tanh") — 在循环块以及解码器层的MLP层中使用的隐藏激活函数。
  • partial_rotary_factor (float, optional, 默认为 0.5) — 用于初始化旋转嵌入的部分旋转因子。
  • rope_theta (float, optional, 默认为 10000.0) — RoPE 嵌入的基础周期。
  • block_types (List[str], 可选, 默认为 ('recurrent', 'recurrent', 'attention')) — 将重复用于初始化 temporal_block 层的交替块列表。
  • attention_dropout (float, optional, defaults to 0.0) — 在注意力softmax之后使用的dropout值.
  • num_key_value_heads (16, 可选, 默认为 16) — 用于 GQA 的键值头数量.
  • attention_bias (bool, optional, defaults to False) — 是否在Attention层的线性q,k,v中添加偏置
  • w_init_variance_scale (float, optional, 默认为 0.01) — 权重初始化方差.

这是用于存储RecurrentGemmaModel配置的配置类。它用于根据指定的参数实例化一个RecurrentGemma模型,定义模型架构。使用默认值实例化配置将产生类似于RecurrentGemma-7B的配置。

例如 google/recurrentgemma-2b

配置对象继承自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.config

RecurrentGemmaModel

transformers.RecurrentGemmaModel

< >

( config: RecurrentGemmaConfig )

参数

  • config (RecurrentGemmaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
  • config — RecurrentGemmaConfig

这是基本的RecurrentGemma模型,输出原始隐藏状态,没有任何特定的头部。 该模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头部等)。

该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

Transformer解码器由config.num_hidden_layers层组成。每一层都是一个RecurrentGemmaDecoderLayer

前进

< >

( 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 of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.n_positions - 1].

    什么是位置ID?

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • use_cache (bool, 可选) — 如果设置为 Truepast_key_values 键值状态将被返回,并可用于加速解码(参见 past_key_values)。
  • output_hidden_states (bool, optional) — 是否返回所有隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 表示输入序列标记在序列中的位置的索引。与position_ids相反, 这个张量不受填充的影响。它用于在正确的位置更新缓存并推断 完整的序列长度。

RecurrentGemmaModel 的前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

RecurrentGemmaForCausalLM

transformers.RecurrentGemmaForCausalLM

< >

( config )

前进

< >

( 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 ) transformers.modeling_outputs.CausalLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.n_positions - 1].

    什么是位置ID?

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • use_cache (bool, 可选) — 如果设置为 Truepast_key_values 键值状态将被返回,并可用于加速解码(参见 past_key_values)。
  • output_hidden_states (bool, optional) — 是否返回所有隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 表示输入序列标记在序列中的位置的索引。与position_ids相反, 这个张量不受填充的影响。它用于在正确的位置更新缓存并推断 完整的序列长度。
  • Args — labels (torch.LongTensor of shape (batch_size, sequence_length), optional): 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略 (掩码),损失仅针对标签在 [0, ..., config.vocab_size] 之间的标记计算。

返回

transformers.modeling_outputs.CausalLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(RecurrentGemmaConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失(用于下一个词的预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(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 的前向方法,重写了 __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?"
< > Update on GitHub