Transformers 文档

GraniteMoeHybrid

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

在模型、数据集和 Spaces 上进行协作

通过加速推理获得更快的示例

切换文档主题

开始使用

此模型于 2025-05-02 发布，并于 2025-05-05 添加到 Hugging Face Transformers。

GraniteMoeHybrid

概述

GraniteMoeHybrid 模型建立在 GraniteMoeSharedModel 和 Bamba 的基础上。其解码层由状态空间层或带有共享专家的 MoE 注意力层组成。默认情况下，注意力层不使用位置编码。

from transformers import AutoModelForCausalLM, AutoTokenizer

model_path = "ibm-granite/granite-4.0-tiny-preview"
tokenizer = AutoTokenizer.from_pretrained(model_path)

# drop device_map if running on CPU
model = AutoModelForCausalLM.from_pretrained(model_path, device_map="auto")
model.eval()

# change input text as desired
prompt = "Write a code to find the maximum value in a list of numbers."

# tokenize the text
input_tokens = tokenizer(prompt, return_tensors="pt")
# generate output tokens
output = model.generate(**input_tokens, max_new_tokens=100)
# decode output tokens into text
output = tokenizer.batch_decode(output)
# loop over the batch to print, in this example the batch size is 1
for i in output:
    print(i)

此 HF 实现由 Sukriti Sharma 和 Alexander Brooks 贡献。

注意事项

GraniteMoeHybridForCausalLM 支持无填充训练，该训练将不同的训练示例串联起来，同时仍将输入作为单独的批次进行处理。通过约 2 倍（取决于模型和数据分布）的速度显著加快推理速度，并通过避免填充标记不必要的计算和内存开销来减少内存使用（如果存在长度不一的示例）。

无填充训练需要 flash-attn、mamba-ssm 和 causal-conv1d 包，并且除了 input_ids 和 labels 之外，还必须将以下参数传递给模型。
- position_ids: torch.LongTensor：批次中每个序列中每个标记的位置索引。
- seq_idx: torch.IntTensor：批次中每个序列的索引。
- FlashAttentionKwargs 中的每个
  - cu_seq_lens_q: torch.LongTensor：所有查询的累积序列长度。
  - cu_seq_lens_k: torch.LongTensor：所有键的累积序列长度。
  - max_length_q: int：批次中最长的查询长度。
  - max_length_k: int：批次中最长的键长度。
不应提供 attention_mask 输入。DataCollatorWithFlattening 使用 return_seq_idx=True 和 return_flash_attn_kwargs=True 以编程方式生成上述附加参数集。有关更多信息，请参阅通过 Flash Attention 改进 Hugging Face 训练效率的博客文章。
```
from transformers import DataCollatorWithFlattening

# Example of using padding-free training
data_collator = DataCollatorWithFlattening(
    tokenizer=tokenizer,
    return_seq_idx=True,
    return_flash_attn_kwargs=True
)
```

GraniteMoeHybridConfig

class transformers.GraniteMoeHybridConfig

< source >

参数

vocab_size (int, optional, defaults to 32000) — GraniteMoeHybrid 模型的词汇表大小。定义调用 GraniteMoeHybridModel 时传入的 inputs_ids 所能表示的不同标记的数量。
hidden_size (int, optional, defaults to 4096) — 隐藏表示的维度。
intermediate_size (int, optional, defaults to 11008) — MLP 表示的维度。
num_hidden_layers (int, optional, defaults to 32) — Transformer 解码器中的隐藏层数量。
num_attention_heads (int, optional, defaults to 32) — Transformer 解码器中每个注意力层的注意力头数。
num_key_value_heads (int, optional) — 这是实现分组查询注意力所需的 key_value 头数。如果 num_key_value_heads=num_attention_heads，则模型将使用多头注意力 (MHA)；如果 num_key_value_heads=1，则模型将使用多查询注意力 (MQA)；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的键和值头应通过对该组内所有原始头进行平均池化来构建。有关更多详细信息，请参阅此论文。如果未指定，则默认为 num_attention_heads。
hidden_act (str 或 function, optional, defaults to "silu") — 解码器中的非线性激活函数（函数或字符串）。
max_position_embeddings (int, optional, defaults to 2048) — 此模型可能始终使用的最大序列长度。
initializer_range (float, optional, defaults to 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。
rms_norm_eps (float, optional, defaults to 1e-06) — rms 归一化层使用的 epsilon。
use_cache (bool, optional, defaults to True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时才相关。
pad_token_id (int, optional) — 填充标记 ID。
bos_token_id (int, optional, defaults to 1) — 流的开始标记 ID。
eos_token_id (int, optional, defaults to 2) — 流的结束标记 ID。
tie_word_embeddings (bool, optional, defaults to False) — 是否绑定权重嵌入
rope_parameters (RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值，以及用于缩放的参数（如果您希望使用更长的 max_position_embeddings 来使用 RoPE）。
attention_bias (bool, optional, defaults to False) — 在自注意力过程中查询、键、值和输出投影层是否使用偏置。
attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。
embedding_multiplier (float, optional, defaults to 1.0) — 嵌入乘数。
logits_scaling (float, optional, defaults to 1.0) — output logits 的除数。
residual_multiplier (float, optional, defaults to 1.0) — residual 乘数。
attention_multiplier (float, optional, defaults to 1.0) — attention 乘数。
num_local_experts (int, optional, defaults to 8) — 总专家数。
num_experts_per_tok (int, optional, defaults to 2) — 每 token 的专家数。
output_router_logits (bool, optional, defaults to False) — 是否返回路由器的 logits。启用此选项还将允许模型输出辅助损失。
router_aux_loss_coef (float, optional, defaults to 0.001) — router 辅助损失系数
shared_intermediate_size (int, optional, defaults to 1024) — 共享专家中间层大小。
position_embedding_type (str, optional) — 将使用的位置嵌入类型；默认为 None。允许的选项：[None, "rope"]
layer_types (List, optional) — 用作层类型的字符串列表。允许的选择：“mamba”，“attention”。
mamba_n_heads (int, optional, defaults to 128) — 使用的 mamba 头数。
mamba_n_groups (int, optional, defaults to 1) — 使用的 mamba 组数。
mamba_d_state (int, optional, defaults to 256) — mamba 隐态空间维度。
mamba_d_head (int, optional, defaults to "auto") — 头嵌入维度大小。
mamba_d_conv (int, optional, defaults to 4) — mamba 卷积核大小。
mamba_expand (int, optional, defaults to 2) — 用于确定 mamba 中间大小的扩展因子（相对于 hidden_size）。
mamba_chunk_size (int, optional, defaults to 256) — 预填充/训练时用于分割序列的块。
mamba_conv_bias (bool, optional, defaults to True) — 标志，指示是否在 mamba 混合器块的卷积层中使用偏置。
mamba_proj_bias (bool, optional, defaults to False) — 标志，指示是否在 mamba 混合器块的输入和输出投影（[“in_proj”, “out_proj”]）中使用偏置。
time_step_min (float, optional, defaults to 0.001) — 用于限制 dt_proj.bias 的最小 time_step。
time_step_max (float, optional, defaults to 0.1) — 用于限制 dt_proj.bias 的最大 time_step。
time_step_limit (tuple, optional, defaults to (0.0, inf)) — 用于钳制的允许的时间步值范围。

这是存储 GraniteMoeHybridConfig 配置的类。它用于根据指定的参数实例化 GraniteMoeHybrid 模型，定义模型架构。

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

>>> from transformers import GraniteMoeHybridModel, GraniteMoeHybridConfig

>>> # Initializing a GraniteMoeHybrid config
>>> configuration = GraniteMoeHybridConfig()


>>> # Accessing the model configuration
>>> configuration = model.config

GraniteMoeHybridModel

class transformers.GraniteMoeHybridModel

< source >

( config: GraniteMoeHybridConfig )

参数

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

裸露的 Granitemoehybrid 模型输出原始隐藏状态，顶部没有任何特定头部。

此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< source >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.models.granitemoehybrid.modeling_granitemoehybrid.GraniteFlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下会忽略填充。

可以通过 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
什么是 attention mask？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的位置索引。选择范围在 [0, config.n_positions - 1]。

什么是位置 ID？
past_key_values (~cache_utils.Cache, optional) — 可以用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常是当 use_cache=True 或 config.use_cache=True 时，在上一个解码阶段由模型返回的 past_key_values。

只有 Cache 实例被允许作为输入，请参阅我们的 kv 缓存指南。如果未传递 past_key_values，则默认会初始化 DynamicCache。

模型将输出与输入相同的缓存格式。

如果使用 past_key_values，则用户需要只输入未处理的 input_ids（其 past key value 状态未传递给此模型）形状为 (batch_size, unprocessed_length)，而不是所有 input_ids 形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以在不传递 input_ids 的情况下，直接传递嵌入表示。如果您希望对如何将 input_ids 索引转换为相关向量的控制程度高于模型的内部嵌入查找矩阵，则此选项很有用。
use_cache (bool, optional) — 如果设置为 True，则会返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 描绘输入序列 token 在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。

transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

返回 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（None）和输入而异的各种元素。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

GraniteMoeHybridModel 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

GraniteMoeHybridForCausalLM

class transformers.GraniteMoeHybridForCausalLM

< source >

( config: GraniteMoeHybridConfig )

参数

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

用于因果语言建模的 Granitemoehybrid 模型。

此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< source >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_router_logits: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下会忽略填充。

可以通过 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
什么是 attention mask？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的位置索引。选择范围在 [0, config.n_positions - 1]。

什么是位置 ID？
past_key_values (~cache_utils.Cache, optional) — 可以用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常是当 use_cache=True 或 config.use_cache=True 时，在上一个解码阶段由模型返回的 past_key_values。

只有 Cache 实例被允许作为输入，请参阅我们的 kv 缓存指南。如果未传递 past_key_values，则默认会初始化 DynamicCache。

模型将输出与输入相同的缓存格式。

如果使用 past_key_values，则用户需要只输入未处理的 input_ids（其 past key value 状态未传递给此模型）形状为 (batch_size, unprocessed_length)，而不是所有 input_ids 形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以在不传递 input_ids 的情况下，直接传递嵌入表示。如果您希望对如何将 input_ids 索引转换为相关向量的控制程度高于模型的内部嵌入查找矩阵，则此选项很有用。
labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）之间。索引设置为 -100 的 token 将被忽略（掩码），损失仅为具有标签在 [0, ..., config.vocab_size] 中的 token 计算。
output_router_logits (bool, optional) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，在推理期间不应返回。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 描绘输入序列 token 在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
logits_to_keep (Union[int, torch.Tensor], optional, defaults to 0) — 如果是 int，则计算最后 logits_to_keep 个 token 的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。仅生成需要最后一个 token 的 logits，并且仅为此 token 计算它可以节省内存，这对于长序列或大词汇量来说非常可观。如果是一个 torch.Tensor，则必须是 1D 的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单个维度）时很有用。

transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

根据配置（None）和输入，transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。
aux_loss (torch.FloatTensor，可选，当提供 labels 时返回) — 稀疏模块的辅助损失。
router_logits (tuple(torch.FloatTensor), 可选, 当传递 output_router_probs=True 且 config.add_router_probs=True 时，或 config.output_router_probs=True 时返回) — 形状为 (batch_size, sequence_length, num_experts) 的 torch.FloatTensor 元组（每一层一个）。

由 MoE 路由器计算的原始路由器对数（softmax 后），这些术语用于计算专家混合模型的辅助损失。
past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

GraniteMoeHybridForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, GraniteMoeHybridForCausalLM

>>> model = GraniteMoeHybridForCausalLM.from_pretrained("ibm-granite/granite-4.0-h-tiny")
>>> tokenizer = AutoTokenizer.from_pretrained("ibm-granite/granite-4.0-h-tiny")

>>> 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."

在 GitHub 上更新

←GraniteMoe GraniteMoeShared→