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 之类的状态空间模型 (SSM) 最近已被证明在中小规模上可以匹敌甚至超越 Transformer。我们表明，这些模型系列实际上密切相关，并开发了一个丰富的理论框架，将 SSM 和注意力机制的变体联系起来，通过对一类结构化半可分矩阵的各种分解来实现连接。我们的状态空间对偶性 (SSD) 框架允许我们设计一种新的架构 (Mamba-2)，其核心层是对 Mamba 的选择性 SSM 的改进，速度提高了 2-8 倍，同时在语言建模方面继续与 Transformer 竞争。
提示
此版本应支持 Mamba 2 的所有实现，特别是 Mistral AI 的 Mamba-2 codestral。 特别是，mamba 2 codestral 发布时的 groups 数量为 8，这可以直观地被认为类似于基于注意力的模型中 kv head 的数量。此模型具有两个不同的前向传递，torch_forward 或 cuda_kernels_forward。 后者在您的环境中找到原始 cuda 内核时使用它们，并且在预填充时速度较慢，即由于高 cpu 开销而需要“预热运行”，请参阅 此处 和 此处。 在没有编译的情况下，torch_forward 实现速度快 3 到 4 倍。 此外，此模型中没有位置嵌入，但有一个 attention_mask 和特定的逻辑来屏蔽掉批量生成情况下的隐藏状态，另请参阅 此处。 因此，除了 mamba2 内核的重新实现之外，批量生成和缓存生成预计会存在细微差异。 此外，cuda 内核或 torch forward 给出的结果预计会略有不同。 SSM 算法严重依赖于张量收缩，张量收缩具有 matmul 等效项，但运算顺序略有不同，使得较小精度下的差异更大。 另请注意，与填充标记对应的隐藏状态的关闭在 2 个地方完成，并且主要已使用左填充进行测试。 右填充会将噪声向下传播，并且不能保证产生令人满意的结果。 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
class transformers.Mamba2Config
< source >( 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, 可选, 默认为 128) — mamba 2 的演化矩阵的 head 数量。 - head_dim (
int, 可选, 默认为 64) — 每个 head 的维度。 - vocab_size (
int, 可选, 默认为 32768) — MAMBA2 模型的词汇表大小。 定义了在调用 Mamba2Model 时传递的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为 4096) — 嵌入和隐藏状态的维度。 - state_size (
int, 可选, 默认为 128) — 状态空间潜在变量的形状。 - num_hidden_layers (
int, 可选, 默认为 64) — 模型中隐藏层的数量。 - layer_norm_epsilon (
float, 可选, 默认为 1e-05) — 层归一化层中使用的 epsilon 值。 - pad_token_id (
int, 可选, 默认为 1) — 填充 token id。 - bos_token_id (
int, 可选, 默认为 0) — 词汇表中句子开始 token 的 id。 - eos_token_id (
int, 可选, 默认为 2) — 词汇表中句子结束 token 的 id。 - expand (
int, 可选, 默认为 2) — 用于确定中间大小的扩展因子。 - conv_kernel (
int, 可选, 默认为 4) — 卷积核的大小。 - n_groups (
int, 可选, 默认为 8) — mamba 2 的演化矩阵的组数。 - use_bias (
bool, 可选, 默认为False) — 是否在 mixer 模块的 [“in_proj”, “out_proj”] 中使用偏置 - use_conv_bias (
bool, 可选, 默认为True) — 是否在 mixer 模块的卷积层中使用偏置。 - hidden_act (
str, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - initializer_range (
float, 可选, 默认为 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, 可选, 默认为(0.0, inf)) — 接受的时间步长值范围。 - rescale_prenorm_residual (
bool, 可选, 默认为False) — 是否在初始化时重新缩放out_proj权重。 - use_cache (
bool, 可选, 默认为True) — 是否应使用缓存。 - rms_norm (
bool, 可选, 默认为True) — 是否使用 RMS 归一化。 - chunk_size (
int, 可选, 默认为 256) — 将构成序列的块的大小。 - tie_word_embeddings (
bool, 可选, 默认为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.configMamba2Model
class transformers.Mamba2Model
< source >( config )
参数
- config (Mamba2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 MAMBA2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( 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.Mamba2Output 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。如果
cache_params.seqlen_offset>0，则只有那些尚未计算过去的input_ids应该作为input_ids传递。索引可以使用 AutoTokenizer 获取。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(batch_size,)的torch.LongTensor, 可选) — 当前输入在缓存中的位置。这用于确保缓存已正确更新。 如果传递了cache_params，则也应传递cache_position。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
返回
transformers.models.mamba2.modeling_mamba2.Mamba2Output 或 tuple(torch.FloatTensor)
一个 transformers.models.mamba2.modeling_mamba2.Mamba2Output 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (Mamba2Config) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层输出端的隐藏状态序列。 -
cache_params (
Mamba2Cache) — 模型在最后时间步的状态。 可以与下一个input_ids一起在 forward 方法中使用，以避免提供旧的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 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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_stateMamba2LMHeadModel
class transformers.Mamba2ForCausalLM
< source >( config )
参数
- config (Mamba2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模 head 的 MAMBA2 模型 Transformer（权重未绑定到输入嵌入的线性层）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( 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.Mamba2CausalLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。如果
cache_params.seqlen_offset>0，则只有未计算过 past 的input_ids应作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递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, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 - cache_position (形状为
(batch_size,)的torch.LongTensor, 可选) — 缓存中当前输入的位置。 这用于确保缓存被正确更新。 如果传递了cache_params，则也应传递cache_position。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择：- 1 代表 未被 mask 的 tokens，
- 0 代表 已被 mask 的 tokens。
- labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于语言建模的标签。 请注意，标签在模型内部被移动，即您可以设置labels = input_ids索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-100的标签都将被忽略（mask），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回
transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutput 或一个 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (Mamba2Config) 和输入的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor, 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
cache_params (
Mamba2Cache) — 模型在最后时间步的状态。 可以与下一个input_ids一起在 forward 方法中使用，以避免提供旧的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 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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