Transformers 文档

Bamba

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

Bamba

PyTorch FlashAttention SDPA

概述

Bamba-9B 是一个仅解码器的语言模型,基于 Mamba-2 架构,旨在处理各种文本生成任务。它从头开始训练,采用两阶段训练方法。在第一阶段,该模型在来自 Dolma v1.7 数据集的 2 万亿个 tokens 上进行训练。在第二阶段,它在 2000 亿个 tokens 上进行额外训练,利用精心策划的高质量数据,进一步优化其性能并提高输出质量。

查看所有 Bamba-9B 模型检查点 此处

BambaConfig

模型 参数 # 层数 隐藏层维度 注意力头数 GQA KV 头数 上下文长度 绑定的嵌入
Bamba 9B (9.78B) 32 4096 32 8 4096

transformers.BambaConfig

< >

( vocab_size = 128000 tie_word_embeddings = False hidden_size = 4096 intermediate_size = 14336 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 hidden_act = 'silu' initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True num_logits_to_keep = 1 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 max_position_embeddings = 262144 attention_dropout = 0.0 attn_layer_indices = None mamba_n_heads = 128 mamba_d_head = 'auto' mamba_n_groups = 1 mamba_d_state = 256 mamba_d_conv = 4 mamba_expand = 2 mamba_chunk_size = 256 mamba_conv_bias = True mamba_proj_bias = False **kwargs )

参数

  • vocab_size (int, 可选的, 默认为 128000) — Bamba 模型的词汇表大小。定义了在调用 BambaModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
  • tie_word_embeddings (bool, 可选的, 默认为 False) — 模型输入和输出词语嵌入是否应该绑定。请注意,这仅在模型具有输出词语嵌入层时才相关。
  • hidden_size (int, 可选的, 默认为 4096) — 隐藏层表示的维度。
  • intermediate_size (int, 可选的, 默认为 14336) — MLP 表示的维度。
  • num_hidden_layers (int, 可选的, 默认为 32) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int, 可选的, 默认为 32) — Transformer 编码器中每个注意力层的注意力头数。
  • num_key_value_heads (int, 可选的, 默认为 8) — 这是用于实现分组查询注意力 (Grouped Query Attention) 的键值对头数。如果 num_key_value_heads=num_attention_heads,模型将使用多头注意力 (Multi Head Attention, MHA);如果 num_key_value_heads=1,模型将使用多查询注意力 (Multi Query Attention, MQA);否则将使用 GQA。当将多头检查点转换为 GQA 检查点时,每个组的键和值头应通过对该组内的所有原始头进行平均池化来构建。有关更多详细信息,请查看 这篇论文。如果未指定,则默认为 8
  • hidden_act (strfunction, 可选的, 默认为 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • initializer_range (float, 可选的, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • rms_norm_eps (float, 可选的, 默认为 1e-05) — RMS 归一化层使用的 epsilon 值。
  • use_cache (bool, 可选的, 默认为 True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅当 config.is_decoder=True 时相关。
  • num_logits_to_keep (intNone, 可选的, 默认为 1) — 生成期间要计算的 prompt logits 数量。如果为 None,将计算所有 logits。如果为整数值,则仅计算最后 num_logits_to_keep 个 logits。默认为 1,因为生成只需要最后一个 prompt token 的 logits。对于长序列,整个序列的 logits 可能会占用大量内存,因此,设置 num_logits_to_keep=1 将显著减少内存占用。
  • pad_token_id (int, 可选的, 默认为 0) — padding token 的 ID。
  • bos_token_id (int, 可选的, 默认为 1) — “beginning-of-sequence” token 的 ID。
  • eos_token_id (int, 可选的, 默认为 2) — “end-of-sequence” token 的 ID。
  • max_position_embeddings (int, 可选的, 默认为 262144) — 模型最大缓存序列长度
  • attention_dropout (float, 可选的, 默认为 0.0) — 注意力概率的 dropout 比率。
  • attn_layer_indices (list, 可选的) — 指定将具有完整注意力的层索引。必须包含最多 num_hidden_layers 的值。
  • mamba_n_heads (int, 可选的, 默认为 128) — v2 实现中使用的 mamba 头数。
  • mamba_d_head (int, 可选的, 默认为 "auto") — 头嵌入维度大小
  • mamba_n_groups (int, 可选的, 默认为 1) — v2 实现中使用的 mamba 组数。
  • mamba_d_state (int, 可选的, 默认为 256) — mamba 状态空间潜在变量的维度
  • mamba_d_conv (int, 可选的, 默认为 4) — mamba 卷积核的大小
  • mamba_expand (int, 可选的, 默认为 2) — 用于确定 mamba 中间大小的扩展因子(相对于 hidden_size)。
  • mamba_chunk_size (int, 可选的, 默认为 256) — 在进行预填充/训练时,将序列分解成的块大小。
  • mamba_conv_bias (bool, 可选的, 默认为 True) — 标志,指示是否在 mamba 混合器块的卷积层中使用偏置。
  • mamba_proj_bias (bool, 可选,默认为 False) — 指示是否在 mamba 混合器模块的输入和输出投影([“in_proj”, “out_proj”])中使用偏置的标志。

这是用于存储 BambaModel 的配置的配置类。它用于根据指定的参数实例化 BambaModel 模型,从而定义模型架构。使用从 ibm-fms/Bamba-9.8b-2.2T-hf 获取的默认值实例化配置。

BambaModel 是一个混合的 mamba2 架构,带有 SwiGLU。这些检查点由 IBM、普林斯顿大学和伊利诺伊大学厄巴纳-香槟分校 (UIUC) 联合训练。

配置对象继承自 PretrainedConfig,并可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。

BambaForCausalLM

from transformers import AutoModelForCausalLM, AutoTokenizer

model = AutoModelForCausalLM.from_pretrained("ibm-fms/Bamba-9B")
tokenizer = AutoTokenizer.from_pretrained("ibm-fms/Bamba-9B")

message = ["Mamba is a snake with following properties  "]
inputs = tokenizer(message, return_tensors='pt', return_token_type_ids=False)
response = model.generate(**inputs, max_new_tokens=64)
print(tokenizer.batch_decode(response, skip_special_tokens=True)[0])

transformers.BambaForCausalLM

< >

( config )

前向传播

< >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.models.bamba.modeling_bamba.HybridMambaAttentionDynamicCache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor,形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示**未被掩码**的标记,
    • 0 表示**被掩码**的标记。

    什么是注意力掩码?

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

    如果使用 past_key_values,则可以选择仅输入最后一个 input_ids(请参阅 past_key_values)。

    如果您想更改填充行为,则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。 有关默认策略的更多信息,请参见 论文 中的图 1。

    • 1 表示头**未被掩码**,
    • 0 表示头**被掩码**。
  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围 [0, config.n_positions - 1] 中选择。

    什么是位置 ID?

  • past_key_values (HybridMambaAttentionDynamicCache, 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 一个 HybridMambaAttentionDynamicCache 对象,包含预先计算的隐藏状态(自注意力模块中的键和值,以及 mamba 模块中的卷积和 ssm 状态),这些状态可以用于(参见 past_key_values 输入)加速顺序解码。键和值缓存张量的形状为 (batch_size, num_heads, seq_len, head_dim)。卷积和 ssm 状态张量的形状分别为 (batch_size, d_inner, d_conv)(batch_size, d_inner, d_state)。有关更多详细信息,请参阅 HybridMambaAttentionDynamicCache 类。

    如果使用 past_key_values,则用户可以选择仅输入最后一个 input_ids(那些没有将其过去的键值状态提供给此模型的输入 ID),形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)input_ids

  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,并且可以用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回的张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回的张量下的 hidden_states
  • output_router_logits (bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用,不应在推理期间返回。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor,形状为 (sequence_length), 可选) — 描述输入序列标记在序列中位置的索引。与 position_ids 相反,此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • labels (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 范围内(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 范围内的标记计算。
  • logits_to_keep (inttorch.Tensor, 可选) — 如果为 int,则计算最后 logits_to_keep 个标记的 logits。如果为 0,则计算所有 input_ids 的 logits(特殊情况)。生成只需要最后一个标记 logits,并且仅为该标记计算它们可以节省内存,这对于长序列或大词汇量大小变得非常重要。如果为 torch.Tensor,则必须为 1D,对应于在序列长度维度中保留的索引。这在使用打包张量格式(批次和序列长度的单个维度)时非常有用。

返回值

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (BambaConfig) 和输入。

  • loss (torch.FloatTensor,形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失(用于下一个标记预测)。

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

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(tuple(torch.FloatTensor)) 元组,其中每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)

    包含预先计算的隐藏状态(自注意力模块中的键和值),这些状态可以用于(参见 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组(如果模型有嵌入层,则为嵌入输出一个,加上每层输出一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出处的隐藏状态,加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

BambaForCausalLM 的前向传播方法覆盖了 __call__ 特殊方法。

虽然前向传播的配方需要在该函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, BambaForCausalLM

>>> model = BambaForCausalLM.from_pretrained("...")
>>> tokenizer = AutoTokenizer.from_pretrained("...")

>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."

此 HF 实现由 ani300fabianlim 贡献。

< > 在 GitHub 上更新