Transformers 文档

FalconMamba

FalconMamba

概述

FalconMamba模型是由阿联酋技术创新研究所(TII)在其发布中提出的。

论文的摘要如下:

我们介绍了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的权重。

提示:

该模型已经在大约6T的token上进行了训练,这些token由多种数据源组成,如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, optional, 默认为 768) — 嵌入和隐藏状态的维度。
  • state_size (int, optional, 默认为 16) — 状态空间潜变量的形状.
  • num_hidden_layers (int, optional, 默认为 32) — 模型中的隐藏层数量。
  • layer_norm_epsilon (float, optional, 默认为 1e-05) — 用于层归一化层的 epsilon 值。
  • pad_token_id (int, optional, 默认为 0) — 填充标记的ID.
  • bos_token_id (int, optional, defaults to 0) — 词汇表中句子开始标记的id。
  • eos_token_id (int, optional, defaults to 0) — 词汇表中句子结束标记的id.
  • expand (int, optional, 默认为 2) — 用于确定中间大小的扩展因子。
  • conv_kernel (int, optional, 默认为 4) — 卷积核的大小.
  • use_bias (bool, 可选, 默认为 False) — 是否在混合器块的 [“in_proj”, “out_proj”] 中使用偏置
  • use_conv_bias (bool, optional, defaults to True) — 是否在混合器块的卷积层中使用偏置。
  • hidden_act (str, 可选, 默认为 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • initializer_range (float, 可选, 默认为 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_scale (float, optional, 默认为 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, optional, defaults to True) — 是否应使用缓存。
  • use_mambapy (bool, 可选, 默认为 False) — 确定在训练期间如果基于CUDA的FalconMamba官方实现不可用时的回退策略。如果为 True,则使用 falcon_mamba.py 实现。如果为 False,则使用简单且较慢的实现。如果内存有限,请考虑切换到简单版本。
  • mixer_rms_eps (float, optional, defaults to 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.config

FalconMambaModel

transformers.FalconMambaModel

< >

( config )

参数

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

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

该模型继承自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.cache_utils.MambaCache] = 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.LongTensor] = None ) transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaOutputtuple(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 (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.FalconMambaOutputtuple(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 的 forward 方法,重写了 __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_state

FalconMambaLMHeadModel

transformers.FalconMambaForCausalLM

< >

( config )

参数

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

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

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

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

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None cache_params: typing.Optional[transformers.cache_utils.MambaCache] = 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 **kwargs ) transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaCausalLMOutputtuple(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 形状为 (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 of shape (batch_size, sequence_length), optional) — 用于语言建模的标签。请注意,标签在模型内部被移位,即你可以设置 labels = input_ids 索引在 [-100, 0, ..., config.vocab_size] 中选择。所有设置为 -100 的标签 将被忽略(掩码),损失仅针对 [0, ..., config.vocab_size] 中的标签计算

返回

transformers.models.falcon_mamba.modeling_falcon_mamba.FalconMambaCausalLMOutputtuple(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 的前向方法,重写了 __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
< > Update on GitHub