Hugging Face 的 LOGO

Transformers 文件

Phi-3

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

Phi-3

PyTorch FlashAttention SDPA

概述

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

摘要

以下是 Phi-3 論文的摘要：

我們推出了 phi-3-mini，一個擁有 38 億引數的語言模型，它在 3.3 萬億個標記上進行了訓練。根據學術基準和內部測試的衡量，其整體效能可與 Mixtral 8x7B 和 GPT-3.5 等模型相媲美（例如，phi-3-mini 在 MMLU 上達到 69%，在 MT-bench 上達到 8.38），儘管它足夠小，可以在手機上部署。創新完全在於我們的訓練資料集，它是 phi-2 所用資料集的升級版，由經過嚴格篩選的網路資料和合成資料組成。該模型還進一步針對魯棒性、安全性和聊天格式進行了對齊。我們還提供了一些初步的引數擴充套件結果，包括一個在 4.8 萬億個標記上訓練的 7B 和 14B 模型，分別稱為 phi-3-small 和 phi-3-medium，它們的能力都明顯強於 phi-3-mini（例如，它們在 MMLU 上分別達到 75% 和 78%，在 MT-bench 上分別達到 8.7 和 8.9）。

Phi-3 的原始程式碼可以在這裡找到。

使用技巧

  • 該模型與 Llama 非常相似，主要區別在於 Phi3SuScaledRotaryEmbedding 和 Phi3YarnScaledRotaryEmbedding，它們用於擴充套件旋轉嵌入的上下文。查詢（query）、鍵（key）和值（value）被融合，MLP 的上取樣和門控投影層也被融合。
  • 此模型使用的分詞器與 LlamaTokenizer 相同，只是增加了一些額外的標記。

如何使用 Phi-3

Phi-3 已被整合到 transformers 的開發版本 (4.40.0.dev) 中。在官方版本透過 pip 釋出之前，請確保你執行了以下操作之一：

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

  • 將本地的 transformers 更新到開發版本：pip uninstall -y transformers && pip install git+https://github.com/huggingface/transformers。前面的命令是克隆並從原始碼安裝的替代方法。

>>> from transformers import AutoModelForCausalLM, AutoTokenizer

>>> model = AutoModelForCausalLM.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")

>>> messages = [{"role": "user", "content": "Can you provide ways to eat combinations of bananas and dragonfruits?"}]
>>> inputs = tokenizer.apply_chat_template(messages, add_generation_prompt=True, return_tensors="pt")

>>> outputs = model.generate(inputs, max_new_tokens=32)
>>> text = tokenizer.batch_decode(outputs)[0]
>>> print(text)
<|user|> Can you provide ways to eat combinations of bananas and dragonfruits?<|end|><|assistant|> Certainly! Bananas and dragonfruits can be combined in various delicious ways. Here are some creative ideas for incorporating both fruits

Phi3Config

class transformers.Phi3Config

< >

( vocab_size = 32064 hidden_size = 3072 intermediate_size = 8192 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None resid_pdrop = 0.0 embd_pdrop = 0.0 attention_dropout = 0.0 hidden_act = 'silu' max_position_embeddings = 4096 original_max_position_embeddings = 4096 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None partial_rotary_factor = 1.0 bos_token_id = 1 eos_token_id = 32000 pad_token_id = 32000 sliding_window = None **kwargs )

引數

  • vocab_size (int, 可選, 預設為 32064) — Phi-3 模型的詞彙表大小。定義了在呼叫 Phi3Model 時，可以透過 inputs_ids 表示的不同標記的數量。
  • hidden_size (int, 可選, 預設為 3072) — 隱藏表示的維度。
  • intermediate_size (int, 可選, 預設為 8192) — MLP 表示的維度。
  • num_hidden_layers (int, 可選, 預設為 32) — Transformer 解碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 32) — Transformer 解碼器中每個注意力層的注意力頭數量。
  • num_key_value_heads (int, 可選) — 這是用於實現分組查詢注意力（Grouped Query Attention）的鍵值（key_value）頭數量。如果 num_key_value_heads=num_attention_heads，模型將使用多頭注意力（MHA）；如果 num_key_value_heads=1，模型將使用多查詢注意力（MQA）；否則將使用 GQA。當將一個多頭檢查點轉換為 GQA 檢查點時，每個組的鍵和值頭應透過對該組內所有原始頭進行平均池化來構建。更多細節，請檢視這篇論文。如果未指定，將預設為 num_attention_heads。
  • resid_pdrop (float, 可選, 預設為 0.0) — MLP 輸出的 Dropout 機率。
  • embd_pdrop (int, 可選, 預設為 0.0) — 嵌入層的 Dropout 比例。
  • attention_dropout (float, 可選, 預設為 0.0) — 計算注意力分數後的 Dropout 比例。
  • hidden_act (str 或 function, 可選, 預設為 "silu") — 解碼器中的非線性啟用函式（函式或字串）。
  • max_position_embeddings (int, 可選, 預設為 4096) — 該模型可能使用的最大序列長度。
  • original_max_position_embeddings (int, 可選, 預設為 4096) — 該模型訓練時使用的最大序列長度。這用於在使用長序列縮放時確定原始 RoPE 嵌入的大小。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • rms_norm_eps (float, 可選, 預設為 1e-05) — 用於 RMSNorm 的 epsilon 值。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在 config.is_decoder=True 時相關。是否繫結權重嵌入。
  • tie_word_embeddings (bool, 可選, 預設為 False) — 是否繫結詞嵌入權重
  • rope_theta (float, 可選, 預設為 10000.0) — RoPE 嵌入的基礎週期。
  • rope_scaling (dict, 可選) — RoPE 嵌入的縮放策略。如果為 None，則不應用縮放。如果是一個字典，它必須包含以下鍵：type、short_factor 和 long_factor。type 必須是 longrope，short_factor 和 long_factor 必須是數字列表，其長度等於隱藏大小除以注意力頭數再除以 2。
  • partial_rotary_factor (float, 可選, 預設為 1.0) — 將應用旋轉嵌入的查詢和鍵的百分比。必須在 0.0 和 1.0 之間。
  • bos_token_id (int, 可選, 預設為 1) — “序列開始”標記的 ID。
  • eos_token_id (int, 可選, 預設為 32000) — “序列結束”標記的 ID。
  • pad_token_id (int, 可選, 預設為 32000) — 填充標記的 ID。
  • sliding_window (int, 可選) — 滑動視窗注意力視窗大小。如果為 None，則不應用滑動視窗。

這是用於儲存 Phi3Model 配置的配置類。它用於根據指定的引數例項化一個 Phi-3 模型，定義模型架構。使用預設值例項化配置將產生與 microsoft/Phi-3-mini-4k-instruct 類似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import Phi3Model, Phi3Config

>>> # Initializing a Phi-3 style configuration
>>> configuration = Phi3Config.from_pretrained("microsoft/Phi-3-mini-4k-instruct")

>>> # Initializing a model from the configuration
>>> model = Phi3Model(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
Pytorch
隱藏 Pytorch 內容

Phi3Model

class transformers.Phi3Model

< >

( config: Phi3Config )

引數

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

基礎的 Phi3 模型，輸出原始的隱藏狀態（hidden-states），頂部沒有任何特定的頭部（head）。

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

該模型也是一個 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch Module 一樣使用它，並參考 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 use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

引數

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

    可以使用 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)` 元組，其中每個元組包含兩個形狀為 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的張量。這也稱為傳統快取格式。

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

    如果使用了 `past_key_values`，使用者可以選擇只輸入最後的 `input_ids`（即那些沒有為其提供過去鍵值狀態的詞元），形狀為 `(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`。
  • cache_position (torch.LongTensor，形狀為 (sequence_length)，可選) — 描述輸入序列詞元在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.BaseModelOutputWithPast 或一個 `torch.FloatTensor` 的元組（如果傳遞 `return_dict=False` 或當 `config.return_dict=False` 時），根據配置（Phi3Config）和輸入包含各種元素。

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

Phi3Model 的前向方法，重寫了 `__call__` 特殊方法。

儘管前向傳遞的配方需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

Phi3ForCausalLM

class transformers.Phi3ForCausalLM

< >

( config )

引數

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

用於因果語言建模的 Phi3 模型。

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

該模型也是一個 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch Module 一樣使用它，並參考 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.phi3.modeling_phi3.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

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

    可以使用 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)` 元組，其中每個元組包含兩個形狀為 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的張量。這也稱為傳統快取格式。

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

    如果使用了 `past_key_values`，使用者可以選擇只輸入最後的 `input_ids`（即那些沒有為其提供過去鍵值狀態的詞元），形狀為 `(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` 的詞元將被忽略（掩碼），損失僅針對標籤在 `[0, ..., config.vocab_size]` 之間的詞元計算。
  • use_cache (bool, 可選) — 如果設定為 `True`，將返回 `past_key_values` 鍵值狀態，並可用於加速解碼（參見 `past_key_values`）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
  • cache_position (torch.LongTensor，形狀為 (sequence_length)，可選) — 描述輸入序列詞元在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
  • logits_to_keep (Union[int, torch.Tensor], 預設為 0) — 如果是 `int`，則為最後 `logits_to_keep` 個詞元計算 logits。如果是 `0`，則為所有 `input_ids` 計算 logits（特殊情況）。生成時只需要最後一個詞元的 logits，僅為此詞元計算可以節省記憶體，這對於長序列或大詞彙表來說非常重要。如果是 `torch.Tensor`，則必須是 1D 的，對應於在序列長度維度中要保留的索引。這在使用打包張量格式（批次和序列長度為單一維度）時很有用。

返回

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

一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 `torch.FloatTensor` 的元組（如果傳遞 `return_dict=False` 或當 `config.return_dict=False` 時），根據配置（Phi3Config）和輸入包含各種元素。

  • loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。

Phi3ForCausalLM 的前向方法，重寫了 `__call__` 特殊方法。

儘管前向傳遞的配方需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, Phi3ForCausalLM

>>> model = Phi3ForCausalLM.from_pretrained("meta-phi3/Phi3-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-phi3/Phi3-2-7b-hf")

>>> 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, 可選) — 用於生成呼叫的基本引數化生成配置。傳遞給 `generate` 的 `**kwargs` 中與 `generation_config` 屬性匹配的引數將覆蓋它們。如果未提供 `generation_config`，將使用預設配置，其載入優先順序如下：1) 如果存在，從 `generation_config.json` 模型檔案載入；2) 從模型配置載入。請注意，未指定的引數將繼承 GenerationConfig 的預設值，應查閱其文件以引數化生成。
  • logits_processor (LogitsProcessorList, 可選) — 自定義 logits 處理器，補充從引數和生成配置中構建的預設 logits 處理器。如果傳遞的 logit 處理器已經透過引數或生成配置建立，則會丟擲錯誤。此功能適用於高階使用者。
  • stopping_criteria (StoppingCriteriaList, 可選) — 自定義停止標準，補充從引數和生成配置中構建的預設停止標準。如果傳遞的停止標準已經透過引數或生成配置建立，則會丟擲錯誤。如果你的停止標準依賴於 `scores` 輸入，請確保向 `generate` 傳遞 `return_dict_in_generate=True, output_scores=True`。此功能適用於高階使用者。
  • prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], 可選) — 如果提供，此函式將在每一步將束搜尋限制為僅允許的詞元。如果未提供，則不應用任何約束。此函式接受 2 個引數：批次 ID `batch_id` 和 `input_ids`。它必須返回一個列表，其中包含基於批次 ID `batch_id` 和先前生成的詞元 `inputs_ids` 條件下的下一個生成步驟允許的詞元。此引數對於基於字首的約束生成非常有用，如 Autoregressive Entity Retrieval 中所述。
  • synced_gpus (bool, 可選) — 是否繼續執行 while 迴圈直到達到 max_length。除非被覆蓋，否則在使用 `FullyShardedDataParallel` 或 DeepSpeed ZeRO Stage 3 並行多 GPU 時，此標誌將設定為 `True`，以避免在一個 GPU 完成生成而其他 GPU 未完成時發生死鎖。否則，預設為 `False`。
  • assistant_model (PreTrainedModel, 可選) — 可用於加速生成的輔助模型。輔助模型必須具有完全相同的分詞器。當使用輔助模型預測候選詞元比使用您呼叫 generate 的模型執行生成要快得多時，可以實現加速。因此，輔助模型應該小得多。
  • streamer (BaseStreamer, 可選) — 將用於流式傳輸生成序列的 streamer 物件。生成的詞元透過 `streamer.put(token_ids)` 傳遞，streamer 負責任何進一步的處理。
  • 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)`。

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

Phi3ForSequenceClassification

class transformers.Phi3ForSequenceClassification

< >

( config )

引數

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

帶有序列分類頭部（線性層）的 Phi3 模型轉換器。

Phi3ForSequenceClassification 使用最後一個詞元來進行分類，就像其他因果模型（例如 GPT-2）一樣。

由於它對最後一個詞元進行分類，因此需要知道最後一個詞元的位置。如果配置中定義了 `pad_token_id`，它會在每一行中找到不是填充詞元的最後一個詞元。如果沒有定義 `pad_token_id`，它只是簡單地取批次中每一行的最後一個值。由於當傳遞 `inputs_embeds` 而不是 `input_ids` 時它無法猜測填充詞元，因此它執行相同的操作（取批次中每一行的最後一個值）。

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

該模型也是一個 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch Module 一樣使用它，並參考 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 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是 input IDs？

  • 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] 範圍內選擇。

    什麼是 position IDs？

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

    允許兩種格式：

    • 一個 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（那些沒有提供其過去鍵值狀態給此模型的 `input_ids`），而不是形狀為 (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,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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` 時），包含各種元素，具體取決於配置 (Phi3Config) 和輸入。

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

Phi3ForSequenceClassification 的 forward 方法重寫了 `__call__` 特殊方法。

儘管前向傳遞的配方需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, Phi3ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-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 = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-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, Phi3ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-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 = Phi3ForSequenceClassification.from_pretrained(
...     "microsoft/Phi-3-mini-4k-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

Phi3ForTokenClassification

class transformers.Phi3ForTokenClassification

< >

( config )

引數

  • config (Phi3ForTokenClassification) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。

Phi3 Transformer 模型，頂部帶有一個 token 分類頭（一個線上性層之上的隱藏狀態輸出），例如用於命名實體識別 (NER) 任務。

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

該模型也是一個 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch Module 一樣使用它，並參考 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.TokenClassifierOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是 input IDs？

  • 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] 範圍內選擇。

    什麼是 position IDs？

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

    允許兩種格式：

    • 一個 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（那些沒有提供其過去鍵值狀態給此模型的 `input_ids`），而不是形狀為 (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,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 `torch.FloatTensor` 元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置 (Phi3Config) 和輸入。

  • loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失。

  • logits (形狀為 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分類分數（SoftMax 之前）。

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

Phi3ForTokenClassification 的 forward 方法重寫了 `__call__` 特殊方法。

儘管前向傳遞的配方需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, Phi3ForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForTokenClassification.from_pretrained("microsoft/Phi-3-mini-4k-instruct")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )

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

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...
< > 在 GitHub 上更新

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