Hugging Face 的 LOGO

Transformers 文件

PhiMoE

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

PhiMoE

PyTorch FlashAttention SDPA

概述

PhiMoE 模型由 Microsoft 在 Phi-3 技術報告：一款可在手機上本地執行的高效能語言模型 中提出。

摘要

Phi-3 論文的摘要如下：

我們推出了 phi-3-mini，一個擁有 38 億引數的語言模型，在 3.3 萬億個 tokens 上進行訓練，其整體效能（透過學術基準和內部測試衡量）可與 Mixtral 8x7B 和 GPT-3.5 等模型媲美（例如，phi-3-mini 在 MMLU 上達到 69%，在 MT-bench 上達到 8.38），儘管它足夠小，可以部署在手機上。我們的訓練資料集是 phi-2 使用的資料集的放大版本，由經過嚴格過濾的公開網路資料和合成資料組成。該模型還進一步針對魯棒性、安全性和聊天格式進行了對齊。我們還提供了引數縮放結果，包括訓練了 4.8T tokens 的 7B 和 14B 模型，分別稱為 phi-3-small 和 phi-3-medium，它們都比 phi-3-mini 強大得多（例如，在 MMLU 上分別達到 75% 和 78%，在 MT-bench 上分別達到 8.7 和 8.9）。為了增強多語言、多模態和長上下文能力，我們推出了 phi-3.5 系列的三個模型：phi-3.5-mini、phi-3.5-MoE 和 phi-3.5-Vision。phi-3.5-MoE 是一個 16 x 3.8B MoE 模型，擁有 66 億個活躍引數，與 Llama 3.1 和 Mixtral 系列等同等規模的其他開源模型相比，在語言推理、數學和程式碼任務中表現出卓越的效能，並與 Gemini-1.5-Flash 和 GPT-4o-mini 持平。同時，phi-3.5-Vision 是一個從 phi-3.5-mini 派生出來的 42 億引數模型，在推理任務中表現出色，並擅長處理單影像和文字提示以及多影像和文字提示。

PhiMoE 的原始程式碼可以在這裡找到。

使用提示

  • 此模型與 Mixtral 非常相似，主要區別在於使用了 Phi3LongRoPEScaledRotaryEmbedding，它們用於擴充套件旋轉嵌入的上下文。查詢、鍵和值是融合的，MLP 的上層和門控投影層也是融合的。
  • 此模型使用的分詞器與 LlamaTokenizer 相同，但額外添加了一些 token。

如何使用 PhiMoE

Phi-3.5-MoE-instruct 已整合到 transformers 的開發版本 (4.44.2.dev) 中。在透過 pip 釋出官方版本之前，請確保您正在執行以下操作：

  • 載入模型時，請確保將 trust_remote_code=True 作為引數傳遞給 from_pretrained() 函式。

可以使用以下命令驗證當前 transformers 版本：pip list | grep transformers。

所需包的示例

flash_attn==2.5.8
torch==2.3.1
accelerate==0.31.0
transformers==4.43.0
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline 

torch.random.manual_seed(0) 

model = AutoModelForCausalLM.from_pretrained( 
    "microsoft/Phi-3.5-MoE-instruct",  
    device_map="cuda",  
    torch_dtype="auto",  
    trust_remote_code=True,  
) 

tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct") 

messages = [ 
    {"role": "system", "content": "You are a helpful AI assistant."}, 
    {"role": "user", "content": "Can you provide ways to eat combinations of bananas and dragonfruits?"}, 
    {"role": "assistant", "content": "Sure! Here are some ways to eat bananas and dragonfruits together: 1. Banana and dragonfruit smoothie: Blend bananas and dragonfruits together with some milk and honey. 2. Banana and dragonfruit salad: Mix sliced bananas and dragonfruits together with some lemon juice and honey."}, 
    {"role": "user", "content": "What about solving an 2x + 3 = 7 equation?"}, 
] 

pipe = pipeline( 
    "text-generation", 
    model=model, 
    tokenizer=tokenizer, 
) 

generation_args = { 
    "max_new_tokens": 500, 
    "return_full_text": False, 
    "temperature": 0.0, 
    "do_sample": False, 
} 

output = pipe(messages, **generation_args) 
print(output[0]['generated_text'])

PhimoeConfig

class transformers.PhimoeConfig

< >

( vocab_size = 32064 hidden_size = 4096 intermediate_size = 6400 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 hidden_act = 'silu' max_position_embeddings = 131072 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 1000000.0 rope_scaling = None sliding_window = None attention_dropout = 0.0 num_experts_per_tok = 2 num_local_experts = 16 output_router_logits = False router_aux_loss_coef = 0.001 router_jitter_noise = 0.01 input_jitter_noise = 0.0 attention_bias = False lm_head_bias = False **kwargs )

引數

  • vocab_size (int, 可選, 預設為 32064) — Phimoe 模型的詞彙表大小。定義了呼叫 PhimoeModel 時傳遞的 inputs_ids 可以表示的不同 tokens 的數量。
  • hidden_size (int, 可選, 預設為 4096) — 隱藏表示的維度。
  • intermediate_size (int, 可選, 預設為 6400) — MLP 表示的維度。
  • num_hidden_layers (int, 可選, 預設為 32) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 32) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • num_key_value_heads (int, 可選, 預設為 8) — 用於實現分組查詢注意力的鍵值頭數量。如果 num_key_value_heads=num_attention_heads，模型將使用多頭注意力 (MHA)；如果 num_key_value_heads=1，模型將使用多查詢注意力 (MQA)；否則使用 GQA。將多頭檢查點轉換為 GQA 檢查點時，每個分組的鍵和值頭應透過對該組中所有原始頭進行平均池化來構建。有關更多詳細資訊，請檢視這篇論文。如果未指定，將預設為 8。
  • hidden_act (str 或 function, 可選, 預設為 "silu") — 解碼器中的非線性啟用函式（函式或字串）。
  • max_position_embeddings (int, 可選, 預設為 4096*32) — 此模型可能使用的最大序列長度。Mixtral 的滑動視窗注意力允許最長達 4096*32 個 tokens 的序列。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • rms_norm_eps (float, 可選, 預設為 1e-05) — RMS 歸一化層使用的 epsilon 值。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 config.is_decoder=True 時才相關。
  • pad_token_id (int, 可選) — 填充 token 的 ID。
  • bos_token_id (int, 可選, 預設為 1) — “序列開始”token 的 ID。
  • eos_token_id (int, 可選, 預設為 2) — “序列結束”token 的 ID。
  • tie_word_embeddings (bool, 可選, 預設為 False) — 模型的輸入和輸出詞嵌入是否應該繫結。
  • rope_theta (float, 可選, 預設為 1000000.0) — RoPE 嵌入的基本週期。
  • rope_scaling (dict, 可選) — RoPE 嵌入的縮放策略。如果為 None，則不應用縮放。如果為字典，則必須包含以下鍵：type、short_factor、long_factor、short_mscale、long_mscale 和 original_max_position_embeddings。type 必須是 longrope，short_mscale 和 long_scale 必須是數字，short_factor 和 long_factor 必須是列表，其中包含與注意力頭大小的一半長度相同的數字，original_max_position_embeddings 必須是整數。
  • sliding_window (int, 可選) — 滑動視窗注意力視窗大小。如果未指定，將預設為 262144。
  • attention_dropout (float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
  • num_experts_per_tok (int, 可選, 預設為 2) — 每個 token 要路由的專家數量，也可以解釋為 top-p 路由引數
  • num_local_experts (int, 可選, 預設為 16) — 每個稀疏 MLP 層的專家數量。
  • output_router_logits (bool, 可選, 預設為 False) — 模型是否應返回路由器的 logits。啟用此功能還將允許模型輸出輔助損失。更多詳細資訊請參見此處
  • router_aux_loss_coef (float, 可選, 預設為 0.001) — 總損失的輔助損失因子。
  • router_jitter_noise (float, 可選, 預設為 0.01) — 新增到路由器中的噪聲量。
  • input_jitter_noise (float, 可選, 預設為 0.0) — 輸入抖動噪聲
  • attention_bias (bool, 可選, 預設為 False) — 注意力偏置
  • lm_head_bias (bool, 可選, 預設為 False) — LM 頭偏置

這是用於儲存 PhimoeModel 配置的配置類。它用於根據指定的引數例項化 Phi-moe 模型，定義模型架構。使用預設值例項化配置將生成與 microsoft/Phi-3.5-MoE-instruct 類似的配置。配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import PhimoeModel, PhimoeConfig
>>> # Initializing a Phi-3 style configuration
>>> configuration = PhimoeConfig.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> # Initializing a model from the configuration
>>> model = PhimoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
Pytorch
隱藏 Pytorch 內容

PhimoeModel

class transformers.PhimoeModel

< >

( config: PhimoeConfig )

引數

  • config (PhimoeConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案進行初始化不會載入與模型相關的權重，只加載配置。請查閱 from_pretrained() 方法以載入模型權重。

不帶任何特定頭部的 Phimoe 模型，輸出原始隱藏狀態。

此模型繼承自 PreTrainedModel。請檢視超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以瞭解所有與一般使用和行為相關的事項。

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.Optional[list[torch.FloatTensor]] = 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 cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.MoeModelOutputWithPast 或 tuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是 input ID？

  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor，可選) — 用於避免在填充 token 索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示**未被遮蔽**的 token，
    • 0 表示**被遮蔽**的 token。

    什麼是注意力掩碼？

  • position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是 position ID？

  • past_key_values (list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態（自注意力塊中的鍵和值，以及交叉注意力塊中的可選鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

    允許兩種格式：

    • Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊式快取格式。

    模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回舊式快取格式。

    如果使用 past_key_values，使用者可以選擇僅輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有將其過去的鍵值狀態提供給此模型的 token），而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可選) — 可選地，您可以直接傳遞嵌入表示，而不是傳遞 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。它們對於計算路由器損失很有用，不應在推理期間返回。
  • cache_position (形狀為 (sequence_length) 的 torch.LongTensor，可選) — 指示輸入序列 token 在序列中的位置的索引。與 position_ids 不同，此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。

返回

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

transformers.modeling_outputs.MoeModelOutputWithPast 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（PhimoeConfig）和輸入的不同元素。

  • last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

  • 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 後），這些術語用於計算專家混合模型的輔助損失。

PhimoeModel 的 forward 方法，重寫了 __call__ 特殊方法。

儘管前向傳播的實現需要在函式內部定義，但之後應該呼叫 Module 例項，而不是直接呼叫此函式，因為前者負責執行預處理和後處理步驟，而後者會默默地忽略它們。

PhimoeForCausalLM

class transformers.PhimoeForCausalLM

 < >

( config )

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.Optional[list[torch.FloatTensor]] = 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **loss_kwargs ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是 input ID？

  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor，可選) — 用於避免在填充 token 索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示**未被遮蔽**的 token，
    • 0 表示**被遮蔽**的 token。

    什麼是注意力掩碼？

  • position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是 position ID？

  • past_key_values (list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態（自注意力塊中的鍵和值，以及交叉注意力塊中的可選鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

    允許兩種格式：

    • Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊式快取格式。

    模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回舊式快取格式。

    如果使用 past_key_values，使用者可以選擇僅輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有將其過去的鍵值狀態提供給此模型的 token），而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可選) — 可選地，您可以直接傳遞嵌入表示，而不是傳遞 input_ids。如果您想對如何將 input_ids 索引轉換為相關向量有更多控制，而不是模型內部的嵌入查詢矩陣，則此功能很有用。
  • labels (形狀為 (batch_size, sequence_length) 的 torch.LongTensor，可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [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。它們對於計算路由器損失很有用，不應在推理期間返回。
  • 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，則必須是 1D 的，對應於序列長度維度中要保留的索引。這在使用打包張量格式（批次和序列長度的單一維度）時很有用。

返回

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

transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（PhimoeConfig）和輸入的不同元素。

  • 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

PhimoeForCausalLM 的 forward 方法，重寫了 __call__ 特殊方法。

儘管前向傳播的實現需要在函式內部定義，但之後應該呼叫 Module 例項，而不是直接呼叫此函式，因為前者負責執行預處理和後處理步驟，而後者會默默地忽略它們。

示例

>>> from transformers import AutoTokenizer, PhimoeForCausalLM
>>> model = PhimoeForCausalLM.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> 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."

生成

 < >

( inputs: typing.Optional[torch.Tensor] = None generation_config: typing.Optional[transformers.generation.configuration_utils.GenerationConfig] = None logits_processor: typing.Optional[transformers.generation.logits_process.LogitsProcessorList] = None stopping_criteria: typing.Optional[transformers.generation.stopping_criteria.StoppingCriteriaList] = None prefix_allowed_tokens_fn: typing.Optional[typing.Callable[[int, torch.Tensor], list[int]]] = None synced_gpus: typing.Optional[bool] = None assistant_model: typing.Optional[ForwardRef('PreTrainedModel')] = None streamer: typing.Optional[ForwardRef('BaseStreamer')] = None negative_prompt_ids: typing.Optional[torch.Tensor] = None negative_prompt_attention_mask: typing.Optional[torch.Tensor] = None use_model_defaults: typing.Optional[bool] = None custom_generate: typing.Optional[str] = None **kwargs ) → ModelOutput 或 torch.LongTensor

引數

  • inputs (根據模態變化形狀的 torch.Tensor，可選) — 用作生成提示或編碼器模型輸入的序列。如果為 None，該方法將其初始化為 bos_token_id 和批次大小為 1。對於僅解碼器模型，inputs 應為 input_ids 的格式。對於編碼器-解碼器模型，inputs 可以表示 input_ids、input_values、input_features 或 pixel_values 中的任何一個。
  • generation_config (GenerationConfig, 可選) — 用作生成呼叫基礎引數化的生成配置。傳遞給生成與 generation_config 屬性匹配的 **kwargs 將覆蓋它們。如果未提供 generation_config，將使用預設值，其載入優先順序如下：1) 如果存在，從 generation_config.json 模型檔案中載入；2) 從模型配置中載入。請注意，未指定的引數將繼承 GenerationConfig 的預設值，應查閱其文件以引數化生成。
  • logits_processor (LogitsProcessorList, 可選) — 補充從引數和生成配置構建的預設 logits 處理器的自定義 logits 處理器。如果傳入的 logits 處理器已用引數或生成配置建立，則會丟擲錯誤。此功能適用於高階使用者。
  • stopping_criteria (StoppingCriteriaList, 可選) — 補充從引數和生成配置構建的預設停止準則的自定義停止準則。如果傳入的停止準則已用引數或生成配置建立，則會丟擲錯誤。如果您的停止準則依賴於 scores 輸入，請確保向 generate 傳遞 return_dict_in_generate=True, output_scores=True。此功能適用於高階使用者。
  • prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], 可選) — 如果提供，此函式將在每一步將束搜尋限制為僅允許的 token。如果未提供，則不應用任何限制。此函式接受 2 個引數：批次 ID batch_id 和 input_ids。它必須返回一個列表，其中包含在批次 ID batch_id 和先前生成的 token inputs_ids 的條件下，下一步生成允許的 token。此引數對於基於字首的約束生成很有用，如 自迴歸實體檢索 中所述。
  • synced_gpus (bool, 可選) — 是否繼續執行 `while` 迴圈直到 `max_length`。除非被覆蓋，如果使用 `FullyShardedDataParallel` 或 DeepSpeed ZeRO Stage 3 與多個 GPU，此標誌將被設定為 `True`，以避免在一個 GPU 比其他 GPU 更早完成生成時發生死鎖。否則，預設為 `False`。
  • assistant_model (PreTrainedModel, 可選) — 可用於加速生成過程的輔助模型。輔助模型必須具有完全相同的分詞器。當使用輔助模型預測候選詞元比使用你正在呼叫 `generate` 的模型執行生成速度快得多時，即可實現加速。因此，輔助模型應該小得多。
  • streamer (BaseStreamer, 可選) — 將用於流式傳輸生成序列的流式傳輸器物件。生成的標記透過 `streamer.put(token_ids)` 傳遞，流式傳輸器負責任何進一步的處理。
  • negative_prompt_ids (torch.LongTensor 形狀為 (batch_size, sequence_length), 可選) — 某些處理器（如 CFG）所需的負面提示。批次大小必須與輸入批次大小匹配。這是一個實驗性功能，在未來版本中可能會有破壞性的 API 更改。
  • negative_prompt_attention_mask (torch.LongTensor 形狀為 (batch_size, sequence_length), 可選) — 用於 `negative_prompt_ids` 的注意力掩碼。
  • use_model_defaults (bool, 可選) — 當設定為 `True` 時，`generation_config` 中未設定的引數將設定為模型特定的預設生成配置 (`model.generation_config`)，而不是全域性預設值 (`GenerationConfig()`)。如果未設定，從 `v4.50` 開始儲存的模型將認為此標誌為 `True`。
  • custom_generate (str, 可選) — 包含 huggingface.co 倉庫名稱的字串。如果提供，將執行該倉庫的 `custom_generate/generate.py` 檔案中定義的自定義 `generate` 函式，而不是標準的 `generate` 方法。請注意，生成邏輯完全由該倉庫定義，返回型別可能與標準的 `generate` 方法不同。
  • kwargs (dict[str, Any], 可選) — `generation_config` 的臨時引數化和/或將轉發到模型 `forward` 函式的其他模型特定 kwargs。如果模型是編碼器-解碼器模型，編碼器特定 kwargs 不應加字首，解碼器特定 kwargs 應加 `decoder_` 字首。

返回

ModelOutput 或 torch.LongTensor

一個 ModelOutput（如果 return_dict_in_generate=True 或 config.return_dict_in_generate=True）或一個 torch.LongTensor。

如果模型不是編碼器-解碼器模型（model.config.is_encoder_decoder=False），則可能的 ModelOutput 型別為

如果模型是編碼器-解碼器模型（model.config.is_encoder_decoder=True），則可能的 ModelOutput 型別為

為具有語言建模頭的模型生成詞元 ID 序列。

大多數生成控制引數都在 `generation_config` 中設定，如果未傳遞，則將設定為模型的預設生成配置。您可以透過將相應引數傳遞給 `generate()` 來覆蓋任何 `generation_config`，例如 `.generate(inputs, num_beams=4, do_sample=True)`。

有關生成策略和程式碼示例的概述，請查閱以下指南。

PhimoeForSequenceClassification

class transformers.PhimoeForSequenceClassification

< >

( config )

引數

Phimoe 模型 Transformer 頂部帶有一個序列分類頭（線性層）。PhimoeForSequenceClassification 使用最後一個標記進行分類，與其他因果模型（如 GPT-2）一樣。由於它對最後一個標記進行分類，因此它需要知道最後一個標記的位置。如果在配置中定義了 `pad_token_id`，它會在每一行中找到不是填充標記的最後一個標記。如果未定義 `pad_token_id`，它只需取批處理中每一行的最後一個值。由於當傳遞 `inputs_embeds` 而不是 `input_ids` 時無法猜測填充標記，因此它也這樣做（取批處理中每一行的最後一個值）。

此模型繼承自 PreTrainedModel。請檢視超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以瞭解所有與一般使用和行為相關的事項。

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.Optional[transformers.cache_utils.Cache] = 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 ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast or tuple(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 表示 被掩碼 的標記。

    什麼是注意力掩碼？

  • position_ids (torch.LongTensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]。

    什麼是位置 ID？

  • past_key_values (~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼前期返回的 `past_key_values`，當 `use_cache=True` 或 `config.use_cache=True` 時。

    允許兩種格式：

    • 一個 Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 `config.n_layers` 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為傳統快取格式。

    模型將輸出與作為輸入提供的快取格式相同的快取格式。如果沒有傳遞 `past_key_values`，將返回傳統快取格式。

    如果使用了 `past_key_values`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有將其過去的鍵值狀態提供給此模型的）形狀為 (batch_size, 1)，而不是所有 `input_ids` 形狀為 (batch_size, sequence_length)。

  • inputs_embeds (torch.FloatTensor 形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果您希望對 `input_ids` 索引如何轉換為相關向量有更多控制，而不是模型的內部嵌入查詢矩陣，這會很有用。
  • labels (torch.LongTensor 形狀為 (batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵）。
  • use_cache (bool, 可選) — 如果設定為 True，將返回 `past_key_values` 鍵值狀態，可用於加速解碼（請參閱 `past_key_values`）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。詳情請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。詳情請參閱返回張量下的 `hidden_states`。

返回

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

一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (PhimoeConfig) 和輸入的不同元素。

  • loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。

  • logits (形狀為 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。

PhimoeForSequenceClassification 的 `forward` 方法，覆蓋了 `__call__` 特殊方法。

儘管前向傳播的實現需要在函式內部定義，但之後應該呼叫 Module 例項，而不是直接呼叫此函式，因為前者負責執行預處理和後處理步驟，而後者會默默地忽略它們。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, PhimoeForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> model = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-instruct")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-instruct", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, PhimoeForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> model = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-instruct", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = PhimoeForSequenceClassification.from_pretrained(
...     "microsoft/Phi-3.5-MoE-instruct", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss
< > 在 GitHub 上更新

←Phi-3 PhoBERT→
© . This site is unofficial and not affiliated with Hugging Face, Inc.