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