Transformers 文档
GraniteMoeHybrid
并获得增强的文档体验
开始使用
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 贡献。
GraniteMoeHybridConfig
class transformers.GraniteMoeHybridConfig
< 来源 >( vocab_size = 32000 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 embedding_multiplier = 1.0 logits_scaling = 1.0 residual_multiplier = 1.0 attention_multiplier = 1.0 num_local_experts = 8 num_experts_per_tok = 2 output_router_logits = False router_aux_loss_coef = 0.001 shared_intermediate_size = 1024 position_embedding_type = None layer_types = None mamba_n_heads = 128 mamba_n_groups = 1 mamba_d_state = 256 mamba_d_head = 'auto' mamba_d_conv = 4 mamba_expand = 2 mamba_chunk_size = 256 mamba_conv_bias = True mamba_proj_bias = False **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32000) — GraniteMoeHybrid 模型的词汇表大小。定义了在调用 GraniteMoeHybridModel 时传入的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为 11008) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是实现分组查询注意力（Grouped Query Attention）时应使用的键值头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则，将使用 GQA。当将一个多头检查点转换为 GQA 检查点时，每个分组的键和值头应通过对该组内所有原始头进行均值池化来构建。更多详情，请参阅 这篇论文。如果未指定，将默认为num_attention_heads。 - hidden_act (
strorfunction, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - pad_token_id (
int, 可选) — 填充标记 ID。 - bos_token_id (
int, 可选, 默认为 1) — 序列开始标记 ID。 - eos_token_id (
int, 可选, 默认为 2) — 序列结束标记 ID。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否绑定词嵌入权重。 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE 嵌入的基础周期。 - rope_scaling (
Dict, 可选) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略：线性和动态。它们的缩放因子必须是大于 1 的浮点数。期望格式为{"type": 策略名称, "factor": 缩放因子}。使用此标志时，不要将max_position_embeddings更新为预期的新最大值。有关这些缩放策略行为的更多信息，请参阅以下帖子：https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验性功能，可能会在未来版本中发生破坏性的 API 变更。 - attention_bias (
bool, 可选, 默认为False) — 在自注意力期间，查询、键、值和输出投影层是否使用偏置。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的丢弃率。 - embedding_multiplier (
float, 可选, 默认为 1.0) — 嵌入乘数。 - logits_scaling (
float, 可选, 默认为 1.0) — 输出 logits 的除数。 - residual_multiplier (
float, 可选, 默认为 1.0) — 残差乘数。 - attention_multiplier (
float, 可选, 默认为 1.0) — 注意力乘数。 - num_local_experts (
int, 可选, 默认为 8) — 专家总数。 - num_experts_per_tok (
int, 可选, 默认为 2) — 每个 token 的专家数量。 - output_router_logits (
bool, 可选, 默认为False) — 模型是否应返回路由器 logits。启用此选项还将允许模型输出辅助损失。 - router_aux_loss_coef (
float, 可选, 默认为 0.001) — 路由器辅助损失系数。 - shared_intermediate_size (
int, 可选, 默认为 1024) — 共享专家的中间大小。 - position_embedding_type (
str, 可选) — 要使用的位置嵌入类型；默认为 None。允许的选项：[None, "rope"] - layer_types (
List, 可选) — 用作层类型的字符串列表。允许的选项：“mamba”，“attention”。 - mamba_n_heads (
int, 可选, 默认为 128) — 使用的 mamba 头数量。 - mamba_n_groups (
int, 可选, 默认为 1) — 使用的 mamba 组数量。 - mamba_d_state (
int, 可选, 默认为 256) — mamba 潜在状态空间的维度。 - mamba_d_head (
int, 可选, 默认为"auto") — 头嵌入维度大小。 - 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”]）中使用偏置的标志。
这是用于存储 GraniteMoeHybridConfig 配置的配置类。它用于根据指定的参数实例化一个 GraniteMoeHybrid 模型，定义模型架构。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
GraniteMoeHybridModel
class transformers.GraniteMoeHybridModel
< 来源 >( config: GraniteMoeHybridConfig )
参数
- config (GraniteMoeHybridConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 Granitemoehybrid 模型，输出原始隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, list[torch.FloatTensor], NoneType] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_router_logits: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选自[0, 1]：- 1 表示 token 未被屏蔽，
- 0 表示 token 被屏蔽。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
Union[~cache_utils.Cache, list[torch.FloatTensor], NoneType]) — 预先计算的隐藏状态（自注意块和交叉注意块中的键和值），可用于加速顺序解码。这通常包括在解码的前一个阶段由模型返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 KV 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)的元组，每个元组有两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，则将返回传统缓存格式。如果使用
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), 可选) — 描绘输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），根据配置（GraniteMoeHybridConfig）和输入，包含各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
Cache, 可选，当传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（自注意块中的键和值，以及可选地，如果 `config.is_encoder_decoder=True`，则在交叉注意块中），可用于（参见 `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 后的注意力权重，用于计算自注意力头中的加权平均值。
GraniteMoeHybridModel 的 forward 方法，重写了 `__call__` 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
GraniteMoeHybridForCausalLM
forward
< 来源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, list[torch.FloatTensor], NoneType] = 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 output_router_logits: 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.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选自[0, 1]：- 1 表示 token 未被屏蔽，
- 0 表示 token 被屏蔽。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
Union[~cache_utils.Cache, list[torch.FloatTensor], NoneType]) — 预先计算的隐藏状态（自注意块和交叉注意块中的键和值），可用于加速顺序解码。这通常包括在解码的前一个阶段由模型返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 KV 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)的元组，每个元组有两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，则将返回传统缓存格式。如果使用
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索引转换为关联向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）中。索引设置为-100的 token 将被忽略（屏蔽），损失仅对标签在[0, ..., config.vocab_size]中的 token 计算。 - 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 (形状为
(sequence_length)的torch.LongTensor, 可选) — 描述输入序列中 token 位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 默认为0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果为0，则为所有input_ids计算 logits（特殊情况）。生成时只需要最后一个 token 的 logits，仅为此 token 计算它们可以节省内存，这对于长序列或大词汇表来说非常重要。如果是torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度使用单一维度）时非常有用。
返回
transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GraniteMoeHybridConfig）和输入包含不同的元素。
-
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时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, sequence_length, num_experts)。由 MoE 路由器计算的原始路由器对数（softmax 后），这些术语用于计算专家混合模型的辅助损失。
-
past_key_values (
Cache, 可选，当传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 KV 缓存指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
GraniteMoeHybridForCausalLM 的前向方法覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GraniteMoeHybridForCausalLM
>>> model = GraniteMoeHybridForCausalLM.from_pretrained("ibm/PowerMoE-3b")
>>> tokenizer = AutoTokenizer.from_pretrained("ibm/PowerMoE-3b")
>>> 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."