Transformers 文档

茅巴 2

贡献
概念指南
API
主要类
模型
内部辅助工具
Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

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发布时,有8个等于的group,这可以直观地理解为与基于注意力的模型中kv头数相似。该模型有两种不同的前向传递,torch_forwardcuda_kernels_forward。后者如果你环境中存在原始cuda内核,将使用它们,而且在预填充上较慢,因为CPU开销高,需要“预热运行”,参见此处此处。不进行编译时,torch_forward实现的速度要快3到4倍。此外,该模型中没有位置嵌入,但有attention_mask和在批量生成情况下的两种特定逻辑,以掩蔽隐藏状态,参见此处。因此,除了重新实现mamba2内核外,批量生成和缓存生成也可能略有差异。此外,cuda内核或torch forward产生的结果可能略有不同。SSM算法严重依赖于张量收缩,它们有矩阵乘法等效的表达,但操作顺序略有不同,这在小精度下使差异更大。另一个要注意的是,与填充令牌对应的隐藏状态的关闭在两个地方进行,主要是与左填充一起进行测试。右填充会向下传播噪声,并不能保证产生满意的结果。tokenizer.padding_side = "left"确保你使用正确的填充方向。

该模型由Molbap贡献,得益于Anton Vlasjuk的巨大帮助。原始代码可在此处找到。

使用方法

简单生成示例:

from transformers import MambaConfig, MambaForCausalLM, 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 = MambaForCausalLM.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 norm_before_gate = True rms_norm = True chunk_size = 256 tie_word_embeddings = False **kwargs )

参数

  • num_headsint可选,默认为128) — Mamba 2进化的矩阵的头数。
  • head_dimint可选,默认为64) — 每个头的维度。
  • vocab_sizeint可选,默认为32768) — MAMBA2模型的词汇量。定义了调用Mamba2Model时通过传递可以表示的不同标记的数量。
  • 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(《布尔值》,可选,默认为True)— 是否在混合模块的卷积层中使用偏置。
  • hidden_act(《字符串》可选,默认为"silu")— 解码器的非线性激活函数(函数或字符串)。
  • initializer_range(《浮点数》,可选,默认为0.1)— 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • 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(《浮点型》,可选,默认为0.1)—— 限制使用的最大time_step值,用于界定dt_proj.bias
  • time_step_floor(《浮点型》,可选,默认为0.0001)—— dt_proj.bias层初始化的最小限制值。
  • time_step_limit(《元组》,可选,默认为(0.0, inf))—— 可接受的时间步长值范围。
  • rescale_prenorm_residual(《布尔型》,可选,默认为False)—— 在初始化时是否缩放out_proj权重。
  • use_cache (bool, 可选, 默认为 True) — 是否使用缓存。
  • norm_before_gate (bool, 可选, 默认为 True) — 选项cuda内核 -是否在门之前进行归一化。
  • 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.config

Mamba2Model

class transformers.Mamba2Model

< >

( config )

参数

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

仅输出原始隐藏状态的裸MAMBA2模型变换器,未在顶部添加任何特定头。

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

此模型也是 PyTorch torch.nn.Module 的子类。可将其用作常规的 PyTorch 模块,并参考 PyTorch 文档以了解所有关于通用使用和行为的问题。

forward

< >

( input_ids: 可选 = None inputs_embeds: 可选 = None cache_params: 可选 = None use_cache: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None cache_position: 可选 = None attention_mask: 可选 = None **kwargs ) transformers.models.mamba2.modeling_mamba2.Mamba2Output or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, input_ids_length)) — 输入序列令牌在词汇表中的索引。

    如果 cache_params.seqlen_offset>0,则仅传递未计算过过去的 input_ids

    索引可以通过使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入索引?

  • inputs_embedstorch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选)— 可以选择直接传递嵌入表示,而不是传递 input_ids。这在需要比模型内部嵌入查找矩阵有更多控制权来将 input_ids 索引转换为相关向量时非常有用。
  • cache_paramsMamba2Cache可选)— 如果传入,模型将使用所有块的前一个状态(这将给出 input_ids 提供的输出,就像模型添加 state_input_ids + input_ids 作为上下文一样)。
  • use_cachebool可选)— 如果设置为 True,将返回 cache_params 以供快速生成下一个 logits。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回结果

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

A 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 的 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)

    每层输出处的隐藏状态以及可选的初始嵌入输出。

The Mamba2Model forward 方法覆盖了特殊的 __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 )

参数

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

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

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

此模型也是 PyTorch torch.nn.Module 的子类。可将其用作常规的 PyTorch 模块,并参考 PyTorch 文档以了解所有关于通用使用和行为的问题。

forward

< >

( input_ids: Optional = None inputs_embeds: Optional = None cache_params: Optional = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None use_cache: Optional = None cache_position: Optional = None attention_mask: Optional = None **kwargs ) transformers.models.mamba2.modeling_mamba2.Mamba2CausalLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, input_ids_length)) — 输入序列标记在词汇表中的索引。

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

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • inputs_embeds(《torch.FloatTensor》形状为 (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_statesbool可选)— 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
  • return_dictbool可选)— 是否返回ModelOutput而不是普通的元组。
  • labelstorch.LongTensor形状为(batch_size, sequence_length)可选)— 语言模型的标签。注意,模型内部标签是偏移的,即您可以将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)和输入的各种元素。

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

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

  • 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 的前向方法覆盖了 __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
< > 在 GitHub 上更新