FalconMamba
概述
FalconMamba 模型是由阿联酋技术创新研究所 (TII UAE) 在其发布版本中提出的。
该论文的摘要是：
我们推出了 FalconMamba，这是一种基于新型 Mamba 架构的新型基础大型语言模型。FalconMamba 使用精心挑选的数据混合物，在 5.8 万亿个标记上进行了训练。作为纯粹的基于 Mamba 的模型，FalconMamba 优于基于 Transformers 的领先开放权重模型，例如 Mistral 7B、Llama3 8B 和 Falcon2 11B。它与 Gemma 7B 旗鼓相当，并且优于具有不同架构设计的模型，例如 RecurrentGemma 9B。目前，FalconMamba 是文献中此规模下性能最佳的 Mamba 模型，超越了现有的 Mamba 和混合 Mamba-Transformer 模型。由于其架构，FalconMamba 的推理速度明显更快，并且长序列生成所需的内存大大减少。尽管最近的研究表明混合 Mamba-Transformer 模型的性能优于纯架构设计，但我们论证并证明了纯 Mamba 设计可以实现与混合设计类似甚至更好的结果。我们在宽松许可下公开提供我们实施的 FalconMamba 的权重。
提示
- FalconMamba 主要基于 Mamba 架构，相同的 提示和最佳实践 也与此相关。
该模型已在大约 6T 个标记上进行了训练，这些标记包含许多数据源的混合，例如 RefineWeb、Cosmopedia 和数学数据。
有关训练过程和架构的更多详细信息，请查看 FalconMamba 的技术论文（即将推出）。
用法
下面我们演示如何使用该模型
from transformers import FalconMambaForCausalLM, AutoTokenizer
import torch
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
model = FalconMambaForCausalLM.from_pretrained("tiiuae/falcon-mamba-7b")
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))该架构还兼容 torch.compile 以实现更快的生成
from transformers import FalconMambaForCausalLM, AutoTokenizer
import torch
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
model = FalconMambaForCausalLM.from_pretrained("tiiuae/falcon-mamba-7b", torch_dtype=torch.bfloat16).to(0)
model = torch.compile(model)
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))如果您有权访问与 bitsandbytes 兼容的 GPU，您还可以将模型量化为 4 位精度
from transformers import FalconMambaForCausalLM, AutoTokenizer, BitsAndBytesConfig
import torch
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
quantization_config = BitsAndBytesConfig(load_in_4bit=True)
model = FalconMambaForCausalLM.from_pretrained("tiiuae/falcon-mamba-7b", quantization_config=quantization_config)
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 transformers import FalconMambaForCausalLM, AutoTokenizer
import torch
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b-instruct")
model = FalconMambaForCausalLM.from_pretrained("tiiuae/falcon-mamba-7b-instruct")
# We use the tokenizer's chat template to format each message - see https://huggingface.co/docs/transformers/main/en/chat_templating
messages = [
{"role": "user", "content": "How many helicopters can a human eat in one sitting?"},
]
input_ids = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True).input_ids
outputs = model.generate(input_ids)
print(tokenizer.decode(outputs[0]))FalconMambaConfig
类 transformers.FalconMambaConfig
< 源代码 >( vocab_size = 50280 hidden_size = 768 state_size = 16 num_hidden_layers = 32 layer_norm_epsilon = 1e-05 pad_token_id = 0 bos_token_id = 0 eos_token_id = 0 expand = 2 conv_kernel = 4 use_bias = False use_conv_bias = True hidden_act = 'silu' initializer_range = 0.1 residual_in_fp32 = True time_step_rank = 'auto' time_step_scale = 1.0 time_step_min = 0.001 time_step_max = 0.1 time_step_init_scheme = 'random' time_step_floor = 0.0001 rescale_prenorm_residual = False use_cache = True use_mambapy = False mixer_rms_eps = 1e-06 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50280) — FALCON_MAMBA 模型的词汇表大小。定义了在调用 FalconMambaModel 时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 768) — 嵌入和隐藏状态的维度。 - state_size (
int, 可选, 默认为 16) — 状态空间潜变量的形状。 - num_hidden_layers (
int, 可选, 默认为 32) — 模型中隐藏层的数量。 - layer_norm_epsilon (
float, 可选, 默认为 1e-05) — 层归一化层中使用的 epsilon 值。 - pad_token_id (
int, 可选, 默认为 0) — 填充标记 ID。 - bos_token_id (
int, 可选, 默认为 0) — 词汇表中句首标记的 ID。 - eos_token_id (
int, 可选, 默认为 0) — 词汇表中句末标记的 ID。 - expand (
int, 可选, 默认为 2) — 用于确定中间大小的扩展因子。 - conv_kernel (
int, 可选, 默认为 4) — 卷积核的大小。 - 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_scale (
float, 可选, 默认为 1.0) — 用于缩放dt_proj.bias的比例。 - time_step_min (
float, 可选, 默认为 0.001) — 用于限制dt_proj.bias的最小time_step。 - time_step_max (
float, 可选, 默认为 0.1) — 用于限制dt_proj.bias的最大time_step。 - time_step_init_scheme (
float, 可选, 默认为"random") — 用于dt_proj.weight的初始化方案。应该是["random","uniform"]中的一个 - time_step_floor (
float, 可选, 默认为 0.0001) —dt_proj.bias层初始化的最小钳位值。 - rescale_prenorm_residual (
bool, 可选, 默认为False) — 初始化时是否重新缩放out_proj权重。 - use_cache (
bool, 可选, 默认为True) — 是否应该使用缓存。 - use_mambapy (
bool, 可选, 默认为False) — 如果基于 CUDA 的 FalconMamba 官方实现不可用，则确定训练期间的回退策略。如果为True，则使用 falcon_mamba.py 实现。如果为False，则使用朴素且较慢的实现。如果内存有限，请考虑切换到朴素版本。 - mixer_rms_eps (
float, 可选, 默认为 1e-06) — 用于 B、C 和 dt 状态的 Mixer RMS 规范化中的 RMS 规范化 epsilon 值。
这是用于存储 FalconMambaModel 配置的配置类。它用于根据指定的参数实例化 FALCON_MAMBA 模型，定义模型架构。使用默认值实例化配置将产生与 FALCON_MAMBA tiiuae/falcon-mamba-7b 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档了解更多信息。
示例
>>> from transformers import FalconMambaConfig, FalconMambaModel
>>> # Initializing a FalconMamba configuration
>>> configuration = FalconMambaConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = FalconMambaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configFalconMambaModel
class transformers.FalconMambaModel
< 源代码 >( config )
参数
- config (FalconMambaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
FALCONMAMBA 模型的裸机 Transformer，输出原始隐藏状态，没有任何特定的头部。
此模型继承自 PreTrainedModel。请查看父类的文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None inputs_embeds: Optional = None cache_params: Optional = None use_cache: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None attention_mask: Optional = None ) → transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, input_ids_length)) — 词汇表中输入序列标记的索引。如果
cache_params.seqlen_offset>0，则只有过去未计算的input_ids应作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - cache_params (
MambaCache，可选) — 如果传递，模型将在所有块中使用先前的状态（这将给出提供的input_ids的输出，就好像模型将state_input_ids + input_ids添加为上下文一样）。 - use_cache (
bool，可选) — 如果设置为True，则返回cache_params，并可用于快速生成下一个 logits。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaOutput 或一个 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FalconMambaConfig) 和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
cache_params (
MambaCache) — 模型在最后一个时间步的状态。可以在下一个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)。模型在每层输出的隐藏状态以及可选的初始嵌入输出。
FalconMambaModel 的前向方法覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此实例，因为前者负责运行前后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FalconMambaModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
>>> model = FalconMambaModel.from_pretrained("tiiuae/falcon-mamba-7b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFalconMambaLMHeadModel
类 transformers.FalconMambaForCausalLM
< 源代码 >( config )
参数
- config (FalconMambaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
FALCONMAMBA 模型变压器，顶部带有语言建模头（线性层，权重与输入嵌入绑定）。
此模型继承自 PreTrainedModel。请查看父类的文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: 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 **kwargs ) → transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaCausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, input_ids_length)) — 词汇表中输入序列标记的索引。如果
cache_params.seqlen_offset>0，则只有尚未计算其过去的input_ids才能作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - cache_params (
MambaCache, 可选) — 如果传递，模型将在所有块中使用先前的状态（这将给出提供的input_ids的输出，就像模型将state_input_ids + input_ids作为上下文一样）。 - use_cache (
bool, 可选) — 如果设置为True，则返回cache_params，并且可以用于快速生成下一个 logits。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 语言建模的标签。请注意，标签在模型内部是**移位的**，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都将被忽略（屏蔽），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回值
transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaCausalLMOutput 或 tuple(torch.FloatTensor)
transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaCausalLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FalconMambaConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,), 可选，当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
cache_params (
MambaCache) — 模型在最后一个时间步的状态。可以在下一个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)。模型在每层输出的隐藏状态以及可选的初始嵌入输出。
FalconMambaForCausalLM forward 方法，覆盖 __call__ 特殊方法。
尽管前向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此实例，因为前者负责运行前后处理步骤，而后者则默默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, FalconMambaForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
>>> model = FalconMambaForCausalLM.from_pretrained("tiiuae/falcon-mamba-7b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits