Transformers 文档

Mamba 2

Mamba 2

概述

Mamba2模型由Tri Dao和Albert Gu在Transformers are SSMs: Generalized Models and Efficient Algorithms Through Structured State Space Duality中提出。它是一个类似于Mamba 1的状态空间模型,在简化的架构中具有更好的性能。

论文的摘要如下:

虽然Transformer一直是深度学习在语言建模中取得成功的主要架构,但最近研究表明,像Mamba这样的状态空间模型(SSMs)在小到中等规模上已经能够与Transformer匹敌甚至超越。我们展示了这些模型家族实际上非常密切相关,并通过深入研究一类结构化的半可分矩阵的各种分解,开发了一个丰富的理论框架,将SSMs与注意力机制的变体联系起来。我们的状态空间对偶性(SSD)框架使我们能够设计一种新的架构(Mamba-2),其核心层是对Mamba的选择性SSM的改进,速度提高了2-8倍,同时在语言建模方面继续与Transformer竞争。

提示:

此版本应支持所有Mamba 2的实现,特别是来自Mistral AI的Mamba-2 codestral。特别是,Mamba 2 codestral发布时带有8个groups,可以直观地认为这与基于注意力模型中的kv头数量相似。 该模型有两种不同的前向传递方式,torch_forwardcuda_kernels_forward。后者如果在您的环境中找到原始的cuda内核,则会使用它们,并且在预填充时较慢,即由于高CPU开销需要“预热运行”,请参见这里这里。在没有编译的情况下,torch_forward实现的速度快3到4倍。此外,该模型中没有位置嵌入,但有一个attention_mask和特定的逻辑来在批量生成的情况下在两个地方屏蔽隐藏状态,请参见这里。因此,除了重新实现mamba2内核外,批量生成和缓存生成预计会有轻微差异。此外,cuda内核或torch前向传递的结果预计会略有不同。SSM算法严重依赖于张量收缩,这些收缩有矩阵乘法等效,但操作顺序略有不同,使得在较小精度下差异更大。 另一个注意事项,对应于填充标记的隐藏状态的关闭在两个地方完成,并且主要在左填充的情况下进行了测试。右填充会传播噪声,并且不能保证产生令人满意的结果。tokenizer.padding_side = "left"确保您使用的是正确的填充侧。

该模型由Molbap贡献,并得到了Anton Vlasjuk的大力帮助。 原始代码可以在这里找到。

用法

一个简单的生成示例:

from transformers import Mamba2Config, Mamba2ForCausalLM, AutoTokenizer
import torch
model_id = 'mistralai/Mamba-Codestral-7B-v0.1'
tokenizer = AutoTokenizer.from_pretrained(model_id, revision='refs/pr/9', from_slow=True, legacy=False)
model = Mamba2ForCausalLM.from_pretrained(model_id, revision='refs/pr/9')
input_ids = tokenizer("Hey how are you doing?", return_tensors= "pt")["input_ids"]

out = model.generate(input_ids, max_new_tokens=10)
print(tokenizer.batch_decode(out))

这是一个用于微调的草稿脚本:

from trl import SFTTrainer
from peft import LoraConfig
from transformers import AutoTokenizer, Mamba2ForCausalLM, TrainingArguments
model_id = 'mistralai/Mamba-Codestral-7B-v0.1'
tokenizer = AutoTokenizer.from_pretrained(model_id, revision='refs/pr/9', from_slow=True, legacy=False)
tokenizer.pad_token = tokenizer.eos_token
tokenizer.padding_side = "left" #enforce padding side left

model = Mamba2ForCausalLM.from_pretrained(model_id, revision='refs/pr/9')
dataset = load_dataset("Abirate/english_quotes", split="train")
# Without CUDA kernels, batch size of 2 occupies one 80GB device
# but precision can be reduced.
# Experiments and trials welcome!
training_args = TrainingArguments(
    output_dir="./results",
    num_train_epochs=3,
    per_device_train_batch_size=2,
    logging_dir='./logs',
    logging_steps=10,
    learning_rate=2e-3
)
lora_config =  LoraConfig(
        r=8,
        target_modules=["embeddings", "in_proj", "out_proj"],
        task_type="CAUSAL_LM",
        bias="none"
)
trainer = SFTTrainer(
    model=model,
    tokenizer=tokenizer,
    args=training_args,
    peft_config=lora_config,
    train_dataset=dataset,
    dataset_text_field="quote",
)
trainer.train()

Mamba2Config

transformers.Mamba2Config

< >

( num_heads = 128 head_dim = 64 vocab_size = 32768 hidden_size = 4096 state_size = 128 num_hidden_layers = 64 layer_norm_epsilon = 1e-05 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 expand = 2 conv_kernel = 4 n_groups = 8 use_bias = False use_conv_bias = True hidden_act = 'silu' initializer_range = 0.1 residual_in_fp32 = True time_step_rank = 'auto' time_step_min = 0.001 time_step_max = 0.1 time_step_floor = 0.0001 time_step_limit = (0.0, inf) rescale_prenorm_residual = False use_cache = True rms_norm = True chunk_size = 256 tie_word_embeddings = False **kwargs )

参数

  • num_heads (int, optional, defaults to 128) — mamba 2 的进化矩阵的头数。
  • head_dim (int, optional, defaults to 64) — 每个头的维度。
  • vocab_size (int, 可选, 默认为 32768) — MAMBA2 模型的词汇量大小。定义了可以通过调用 Mamba2Model 时传递的 inputs_ids 表示的不同标记的数量。
  • hidden_size (int, optional, defaults to 4096) — 嵌入和隐藏状态的维度。
  • state_size (int, 可选, 默认为 128) — 状态空间潜变量的形状.
  • num_hidden_layers (int, optional, defaults to 64) — 模型中的隐藏层数量。
  • layer_norm_epsilon (float, optional, defaults to 1e-05) — 用于层归一化层的epsilon值。
  • pad_token_id (int, optional, 默认为 1) — 填充标记的ID.
  • bos_token_id (int, optional, defaults to 0) — 词汇表中句子开始标记的id.
  • eos_token_id (int, optional, defaults to 2) — 词汇表中句子结束标记的id.
  • expand (int, optional, 默认为 2) — 用于确定中间大小的扩展因子。
  • conv_kernel (int, optional, 默认为 4) — 卷积核的大小.
  • n_groups (int, 可选, 默认为 8) — mamba 2 的进化矩阵的组数。
  • use_bias (bool, 可选, 默认为 False) — 是否在混合器块的 [“in_proj”, “out_proj”] 中使用偏置
  • use_conv_bias (bool, optional, defaults to True) — 是否在混合器块的卷积层中使用偏置。
  • hidden_act (str, 可选, 默认为 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • initializer_range (float, optional, 默认为 0.1) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • residual_in_fp32 (bool, 可选, 默认为 True) — 残差是否应为 float32。如果设置为 False,残差将保持与模型其余部分相同的 dtype
  • time_step_rank (Union[int,str], 可选, 默认为 "auto") — 离散化投影矩阵的秩。"auto" 表示它将默认为 math.ceil(self.hidden_size / 16)
  • time_step_min (float, 可选, 默认为 0.001) — 用于限制 dt_proj.bias 的最小 time_step.
  • time_step_max (float, 可选, 默认为 0.1) — 用于限制 dt_proj.bias 的最大 time_step.
  • time_step_floor (float, 可选, 默认值为 0.0001) — dt_proj.bias 层初始化的最小钳位值。
  • time_step_limit (tuple, optional, defaults to (0.0, inf)) — 接受的时间步长值范围。
  • rescale_prenorm_residual (bool, 可选, 默认为 False) — 是否在初始化时重新缩放 out_proj 权重.
  • use_cache (bool, 可选, 默认为 True) — 是否应使用缓存。
  • rms_norm (bool, optional, defaults to True) — 是否使用RMS归一化。
  • chunk_size (int, optional, defaults to 256) — 组成序列的块的大小。
  • tie_word_embeddings (bool, optional, defaults to False) — 是否绑定词嵌入。

这是用于存储Mamba2Model配置的配置类。它用于根据指定的参数实例化一个MAMBA2模型,定义模型架构。使用默认值实例化配置将产生与MAMBA2 state-spaces/mamba2-2.8b架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import Mamba2Config, Mamba2Model

>>> # Initializing a Mamba2 configuration
>>> configuration = Mamba2Config()

>>> # Initializing a model (with random weights) from the configuration
>>> model = Mamba2Model(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

Mamba2Model

transformers.Mamba2Model

< >

( config )

参数

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

裸的MAMBA2模型变压器输出原始隐藏状态,顶部没有任何特定的头部。

该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。

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

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.LongTensor] = None cache_params: typing.Optional[transformers.models.mamba2.modeling_mamba2.Mamba2Cache] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None **kwargs ) transformers.models.mamba2.modeling_mamba2.Mamba2Outputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, input_ids_length)) — Indices of input sequence tokens in the vocabulary.

    如果 cache_params.seqlen_offset>0,只有那些尚未计算其过去的 input_ids 应该作为 input_ids 传递。

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

    什么是输入ID?

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为相关向量有更多控制权,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • cache_params (Mamba2Cache, 可选) — 如果传递了该参数,模型将在所有块中使用先前的状态(这将为提供的input_ids输出,就像模型将state_input_ids + input_ids作为上下文一样)。
  • use_cache (bool, 可选) — 如果设置为 True,则返回 cache_params,并可用于快速生成下一个 logits。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (batch_size,), optional) — 当前输入在缓存中的位置。这用于确保缓存正确更新。 如果传递了cache_params,则也应传递cache_position
  • attention_mask (torch.FloatTensor 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.

    什么是注意力掩码?

返回

transformers.models.mamba2.modeling_mamba2.Mamba2Outputtuple(torch.FloatTensor)

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

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • cache_params (Mamba2Cache) — 模型在最后一个时间步的状态。可以在前向方法中与下一个 input_ids 一起使用,以避免提供旧的 input_ids

    包括选择性扫描后的状态空间模型状态矩阵和卷积状态。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上可选的初始嵌入输出。

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

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

示例:

>>> from transformers import AutoTokenizer, Mamba2Model
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/mamba-codestral-7B-v0.1")
>>> model = Mamba2Model.from_pretrained("mistralai/mamba-codestral-7B-v0.1")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

Mamba2LMHeadModel

transformers.Mamba2ForCausalLM

< >

( config )

参数

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

MAMBA2模型转换器,顶部带有语言建模头(线性层的权重未与输入嵌入绑定)。

该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。

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

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None cache_params: typing.Optional[transformers.models.mamba2.modeling_mamba2.Mamba2Cache] = 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 cache_position: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None **kwargs ) transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, input_ids_length)) — Indices of input sequence tokens in the vocabulary.

    如果 cache_params.seqlen_offset>0,只有那些尚未计算其过去的 input_ids 应该作为 input_ids 传递。

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

    什么是输入ID?

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • cache_params (Mamba2Cache, 可选) — 如果传递了此参数,模型将在所有块中使用先前的状态(这将为提供的input_ids输出,就像模型将state_input_ids + input_ids作为上下文一样)。
  • use_cache (bool, optional) — 如果设置为 True,则返回 cache_params,并可用于快速生成下一个 logits。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (batch_size,), optional) — 当前输入在缓存中的位置。这用于确保缓存被正确更新。 如果传递了cache_params,则也应传递cache_position
  • attention_mask (torch.FloatTensor 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.

    什么是注意力掩码?

  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于语言建模的标签。请注意,标签在模型内部被移位,即你可以设置 labels = input_ids 索引在 [-100, 0, ..., config.vocab_size] 中选择。所有设置为 -100 的标签 将被忽略(掩码),损失仅针对 [0, ..., config.vocab_size] 中的标签计算

返回

transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutputtuple(torch.FloatTensor)

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

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

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前每个词汇标记的分数)。

  • cache_params (Mamba2Cache) — 模型在最后一个时间步的状态。可以在前向方法中与下一个 input_ids 一起使用,以避免提供旧的 input_ids

    包括选择性扫描后的状态空间模型状态矩阵和卷积状态。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上可选的初始嵌入输出。

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

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

示例:

>>> import torch
>>> from transformers import AutoTokenizer, Mamba2ForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/mamba-codestral-7B-v0.1")
>>> model = Mamba2ForCausalLM.from_pretrained("mistralai/mamba-codestral-7B-v0.1")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits
< > Update on GitHub