Transformers 文档
Mamba 2
并获得增强的文档体验
开始使用
Mamba 2
Mamba 2 基于状态空间对偶 (SSD) 框架，该框架连接了结构化状态空间模型 (SSM) 和注意力变体。它使用更高效的 SSD 算法，比 Mamba 快 2-8 倍，并修改了架构以支持张量并行和分组值注意力 (GVA) 头结构。
你可以在 State Space Models 组织下找到所有原始的 Mamba 2 checkpoint，但下面显示的示例使用了 mistralai/Mamba-Codestral-7B-v0.1，因为原始 checkpoint 尚不支持 Hugging Face 实现。
点击右侧边栏中的 Mamba 模型，查看更多如何将 Mamba 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行生成文本。
hfoptions id=“usage”>
<hfoption id="Pipeline">import torch
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="mistralai/Mamba-Codestral-7B-v0.1",
torch_dtype=torch.bfloat16,
device=0
)
pipeline("Plants create energy through a process known as")import torch
from transformers import AutoModelForCausalLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1")
model = AutoModelForCausalLM.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1", torch_dtype=torch.bfloat16, device_map="auto")
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to("cuda")
output = model.generate(**input_ids)
print(tokenizer.decode(output[0], skip_special_tokens=True))echo -e "Plants create energy through a process known as" | transformers-cli run --task text-generation --model mistralai/Mamba-Codestral-7B-v0.1 --device 0量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
下面的示例使用 torchao 仅将权重量子化为 4 位整数。
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig
quantization_config = TorchAoConfig("int4_weight_only", group_size=128)
tokenizer = AutoTokenizer.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1")
model = AutoModelForCausalLM.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1", torch_dtype=torch.bfloat16, quantization_config=quantization_config, device_map="auto")
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to("cuda")
output = model.generate(**input_ids)
print(tokenizer.decode(output[0], skip_special_tokens=True))说明
Codestral Mamba 有
groups=8，这类似于基于注意力的模型中的 kv 头的数量。Codestral Mamba 有两个不同的前向传播过程，
torch_forward或cuda_kernels_forward，它们的结果预计会略有不同。此模型中没有位置嵌入，但在两个地方有一个
attention_mask和特定的逻辑来掩码隐藏状态，用于批处理生成（更多细节请参见此评论）。这（以及重新实现的 Mamba 2 内核的增加）导致批处理和缓存生成之间存在轻微差异。SSM 算法严重依赖张量收缩，它有等效的矩阵乘法，但操作顺序略有不同。这使得在较小精度下的差异更大。
与填充标记相对应的隐藏状态在两个地方被关闭，并且主要使用左填充进行测试。右填充会向下传播噪声，不能保证产生满意的结果。
tokenizer.padding_side = "left"确保你使用正确的填充侧。以下示例演示了如何使用 PEFT 对 Mamba 2 进行微调。
from datasets import load_dataset
from peft import LoraConfig
from trl import SFTConfig, SFTTrainer
model_id = "mistralai/Mamba-Codestral-7B-v0.1"
dataset = load_dataset("Abirate/english_quotes", split="train")
training_args = SFTConfig(dataset_text_field="quote", gradient_checkpointing=True, per_device_train_batch_size=4)
lora_config = LoraConfig(target_modules=["x_proj", "embeddings", "in_proj", "out_proj"])
trainer = SFTTrainer(
model=model_id,
args=training_args,
train_dataset=dataset,
peft_config=lora_config,
)
trainer.train()Mamba2Config
class 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，可选，默认为 128) — Mamba 2 演化矩阵的头数。 - head_dim (
int，可选，默认为 64) — 每个头的维度。 - vocab_size (
int，可选，默认为 32768) — MAMBA2 模型的词汇表大小。定义了在调用 Mamba2Model 时，可以通过inputs_ids表示的不同标记的数量。 - 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) — 填充标记的 ID。 - bos_token_id (
int，可选，默认为 0) — 词汇表中句子开头标记的 ID。 - eos_token_id (
int，可选，默认为 2) — 词汇表中句子结尾标记的 ID。 - expand (
int，可选，默认为 2) — 用于确定中间大小的扩展因子。 - conv_kernel (
int，可选，默认为 4) — 卷积核的大小。 - n_groups (
int，可选，默认为 8) — Mamba 2 演化矩阵的组数。 - use_bias (
bool，可选，默认为False) — 是否在混合器块的 [“in_proj”, “out_proj”] 中使用偏置。 - use_conv_bias (
bool，可选，默认为True) — 是否在混合器块的卷积层中使用偏置。 - 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
< 来源 >( config )
参数
- config (Mamba2Model) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 Mamba2 模型，输出原始的隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类的文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( 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 (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (
torch.LongTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递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 (
torch.LongTensor，形状为(batch_size,)，可选) — 当前输入在缓存中的位置。这用于确保缓存被正确更新。如果传递了cache_params，也应传递cache_position。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[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, 可选，默认为None) — 模型最后一层输出的隐藏状态序列。 -
cache_params (
~models.mamba2.modeling_mamba2.Mamba2Cache, 可选, 默认为None) — 模型在最后一个时间步的状态。可以在前向方法中使用下一个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 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数内定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。
Mamba2LMHeadModel
class transformers.Mamba2ForCausalLM
< 来源 >( config )
参数
- config (Mamba2ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
MAMBA2 模型，其顶部带有一个语言建模头（线性层，权重与输入嵌入不绑定）。
该模型继承自 PreTrainedModel。请查看超类的文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( 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 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递input_ids，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，这会非常有用。 - cache_params (
Mamba2Cache, 可选) — 如果传递该参数，模型将在所有块中使用先前的状态（这将给出所提供input_ids的输出，就好像模型将state_input_ids + input_ids作为上下文一样）。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于语言建模的标签。请注意，标签在模型内部会进行移位，即你可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都会被忽略（遮盖），损失仅对[0, ..., config.vocab_size]中的标签进行计算。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, 可选) — 是返回一个 ModelOutput 而不是一个普通的元组。 - use_cache (
bool, 可选) — 如果设置为True，将返回cache_params，可用于快速生成下一个 logits。 - cache_position (
torch.LongTensor，形状为(batch_size,)，可选) — 当前输入在缓存中的位置。这用于确保缓存被正确更新。如果传递了cache_params，也应传递cache_position。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
返回
transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（Mamba2Config）和输入，包含各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
cache_params (
~models.mamba2.modeling_mamba2.Mamba2Cache, 可选, 默认为None) — 模型在最后一个时间步的状态。可以在前向方法中使用下一个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 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数内定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理前处理和后处理步骤，而后者会静默地忽略它们。