Phi4 多模態

概述

Phi4 多模態是一個輕量級開放多模態基礎模型，它利用了 Phi-3.5 和 4.0 模型所使用的語言、視覺和語音研究及資料集。該模型處理文字、影像和音訊輸入，生成文字輸出，並具有 128K 令牌上下文長度。該模型經過了增強過程，結合了監督微調、直接偏好最佳化和 RLHF（基於人類反饋的強化學習），以支援精確的指令遵循和安全措施。每種模態支援的語言如下：

文字：阿拉伯語、中文、捷克語、丹麥語、荷蘭語、英語、芬蘭語、法語、德語、希伯來語、匈牙利語、義大利語、日語、韓語、挪威語、波蘭語、葡萄牙語、俄語、西班牙語、瑞典語、泰語、土耳其語、烏克蘭語
視覺：英語
音訊：英語、中文、德語、法語、義大利語、日語、西班牙語、葡萄牙語

該模型由 Cyril Vallez 貢獻。最新程式碼可在此處找到。

使用技巧

Phi4-multimodal-instruct 可以在 Huggingface Hub 上找到

接下來，我們將演示如何根據輸入模態（文字、影像、音訊）進行推理。

import torch
from transformers import AutoModelForCausalLM, AutoProcessor, GenerationConfig


# Define model path
model_path = "microsoft/Phi-4-multimodal-instruct"
device = "cuda:0"

# Load model and processor
processor = AutoProcessor.from_pretrained(model_path)
model = AutoModelForCausalLM.from_pretrained(model_path, device_map=device,  torch_dtype=torch.float16)

# Optional: load the adapters (note that without them, the base model will very likely not work well)
model.load_adapter(model_path, adapter_name="speech", device_map=device, adapter_kwargs={"subfolder": 'speech-lora'})
model.load_adapter(model_path, adapter_name="vision", device_map=device, adapter_kwargs={"subfolder": 'vision-lora'})

# Part : Image Processing
messages = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "https://www.ilankelman.org/stopsigns/australia.jpg"},
            {"type": "text", "text": "What is shown in this image?"},
        ],
    },
]

model.set_adapter("vision") # if loaded, activate the vision adapter
inputs = processor.apply_chat_template(
    messages,
    add_generation_prompt=True,
    tokenize=True,
    return_dict=True,
    return_tensors="pt",
).to(device)

# Generate response
generate_ids = model.generate(
    **inputs,
    max_new_tokens=1000,
    do_sample=False,
)
generate_ids = generate_ids[:, inputs['input_ids'].shape[1]:]
response = processor.batch_decode(
    generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False
)[0]
print(f'>>> Response\n{response}')


# Part 2: Audio Processing
model.set_adapter("speech") # if loaded, activate the speech adapter
audio_url = "https://upload.wikimedia.org/wikipedia/commons/b/b0/Barbara_Sahakian_BBC_Radio4_The_Life_Scientific_29_May_2012_b01j5j24.flac"
messages = [
    {
        "role": "user",
        "content": [
            {"type": "audio", "url": audio_url},
            {"type": "text", "text": "Transcribe the audio to text, and then translate the audio to French. Use <sep> as a separator between the origina transcript and the translation."},
        ],
    },
]

inputs = processor.apply_chat_template(
    messages,
    add_generation_prompt=True,
    tokenize=True,
    return_dict=True,
    return_tensors="pt",
).to(device)

generate_ids = model.generate(
    **inputs,
    max_new_tokens=1000,
    do_sample=False,
)
generate_ids = generate_ids[:, inputs['input_ids'].shape[1]:]
response = processor.batch_decode(
    generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False
)[0]
print(f'>>> Response\n{response}')

Phi4MultimodalFeatureExtractor

class transformers.Phi4MultimodalFeatureExtractor

< 來源 >

( feature_size: int = 80 sampling_rate: int = 16000 hop_length: int = 160 n_fft: int = 512 win_length: int = 400 preemphasis: float = 0.97 padding_value: float = 0.0 audio_compression_rate: int = 8 audio_downsample_rate: int = 1 audio_feat_stride: int = 1 mel_min_frequency: float = 0 mel_max_frequency: float = 7690 **kwargs )

Phi4MultimodalImageProcessorFast

class transformers.Phi4MultimodalImageProcessorFast

< 來源 >

( **kwargs: typing_extensions.Unpack[transformers.models.phi4_multimodal.image_processing_phi4_multimodal_fast.Phi4MultimodalFastImageProcessorKwargs] )

構造一個快速的 Phi4 多模態影像處理器。

pad_to_max_num_crops

< 來源 >

( images max_crops = 5 )

影像：B x 3 x H x W，B <= 最大裁剪數

預處理

< 來源 >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] **kwargs: typing_extensions.Unpack[transformers.models.phi4_multimodal.image_processing_phi4_multimodal_fast.Phi4MultimodalFastImageProcessorKwargs] ) → <class 'transformers.image_processing_base.BatchFeature'>

引數

images (Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]) — 要預處理的影像。期望單個或批次影像，畫素值範圍為 0 到 255。如果傳入畫素值在 0 到 1 之間的影像，請設定 do_rescale=False。
do_resize (bool, 可選) — 是否調整影像大小。
size (dict[str, int], 可選) — 描述模型最大輸入維度。
default_to_square (bool, 可選) — 如果大小為整數，調整影像大小是否預設為正方形。
resample (Union[PILImageResampling, F.InterpolationMode, NoneType]) — 如果調整影像大小，要使用的重取樣過濾器。這可以是列舉 PILImageResampling 之一。僅在 do_resize 設定為 True 時有效。
do_center_crop (bool, 可選) — 是否中心裁剪影像。
crop_size (dict[str, int], 可選) — 應用 center_crop 後輸出影像的大小。
do_rescale (bool, 可選) — 是否重新縮放影像。
rescale_factor (Union[int, float, NoneType]) — 如果 do_rescale 設定為 True，用於重新縮放影像的縮放因子。
do_normalize (bool, 可選) — 是否對影像進行歸一化。
image_mean (Union[float, list[float], NoneType]) — 用於歸一化的影像平均值。僅在 do_normalize 設定為 True 時有效。
image_std (Union[float, list[float], NoneType]) — 用於歸一化的影像標準差。僅在 do_normalize 設定為 True 時有效。
do_convert_rgb (bool, 可選) — 是否將影像轉換為 RGB。
return_tensors (Union[str, ~utils.generic.TensorType, NoneType]) — 如果設定為 `pt`，則返回堆疊張量，否則返回張量列表。
data_format (~image_utils.ChannelDimension, 可選) — 僅支援 ChannelDimension.FIRST。為與慢速處理器相容而新增。
input_data_format (Union[str, ~image_utils.ChannelDimension, NoneType]) — 輸入影像的通道維度格式。如果未設定，則從輸入影像推斷通道維度格式。可以是以下之一：
- "channels_first" 或 ChannelDimension.FIRST：影像為 (num_channels, height, width) 格式。
- "channels_last" 或 ChannelDimension.LAST：影像為 (height, width, num_channels) 格式。
- "none" 或 ChannelDimension.NONE：影像為 (height, width) 格式。
device (torch.device, 可選) — 處理影像的裝置。如果未設定，則從輸入影像推斷裝置。
disable_grouping (bool, 可選) — 是否停用按大小分組影像以單獨而不是批次處理它們。如果為 None，則如果影像在 CPU 上，則設定為 True，否則設定為 False。此選擇基於經驗觀察，詳情請參閱：https://github.com/huggingface/transformers/pull/38157
patch_size (int, 可選) — 補丁大小。
dynamic_hd (int, 可選) — 每張影像的最大裁剪數。

<class 'transformers.image_processing_base.BatchFeature'>

data (dict) — 由 call 方法返回的列表/陣列/張量字典（“pixel_values”等）。
tensor_type (Union[None, str, TensorType], 可選) — 您可以在此處提供一個`tensor_type`，以便在初始化時將整數列表轉換為PyTorch/TensorFlow/Numpy張量。

Phi4MultimodalProcessor

class transformers.Phi4MultimodalProcessor

< 來源 >

( image_processor audio_processor tokenizer **kwargs )

引數

image_processor (Phi4MultimodalImageProcessorFast) — 用於影像的影像處理器。
audio_processor (Phi4MultimodalFeatureExtractor) — 用於音訊輸入的音訊處理器。
tokenizer (GPT2TokenizerFast) — 用於文字的分詞器。
fake_image_token_pattern (str, 可選, 預設為 r"<\|image_\d+\|>") — 偽影像令牌模式。
fake_audio_token_pattern (str, 可選, 預設為 r"<\|audio_\d+\|>") — 偽音訊令牌模式。

構造一個 Phi4Multimodal 處理器，它將影像處理器、音訊處理器和 GPT 分詞器封裝到一個單一處理器中。

Phi4MultimodalProcessor 提供了 Phi4MultimodalImageProcessorFast 和 GPT2Tokenizer 的所有功能。有關更多資訊，請參見 __call__() 和 decode()。

batch_decode

< source >

( *args **kwargs )

此方法將其所有引數轉發給 GPT2Tokenizer 的 batch_decode()。有關此方法的更多資訊，請參閱其文件字串。

解碼

< source >

( *args **kwargs )

此方法將其所有引數轉發給 GPT2Tokenizer 的 decode()。有關此方法的更多資訊，請參閱其文件字串。

Phi4MultimodalAudioConfig

class transformers.Phi4MultimodalAudioConfig

< source >

( hidden_size: int = 1024 intermediate_size: int = 1536 num_blocks: int = 24 num_attention_heads: int = 16 activation: str = 'swish' chunk_size: int = -1 left_chunk: int = 18 dropout_rate: float = 0.0 ext_pw_out_channel: int = 1024 depthwise_seperable_out_channel: int = 1024 depthwise_multiplier: int = 1 kernel_size: int = 3 conv_activation: str = 'swish' input_size: int = 80 conv_glu_type: str = 'swish' time_reduction: int = 8 bias_max_distance: int = 1000 bias_symmetric: bool = False nemo_activation: str = 'relu' nemo_conv_channels: int = 1024 downsample_rate: int = 1 initializer_range: float = 0.02 audio_token_id: int = 200011 feature_layer: int = -2 **kwargs )

引數

hidden_size (int, 可選, 預設為 1024) — 編碼器層的維度。
intermediate_size (int, 可選, 預設為 1536) — Transformer 編碼器中“中間”（即前饋）層的維度。
num_blocks (int, 可選, 預設為 24) — Transformer 編碼器中的隱藏層數量。
num_attention_heads (int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數量。
activation (str, 可選, 預設為 "swish") — MLP 中的非線性啟用函式。
chunk_size (int, 可選, 預設為 -1) — 建立掩碼的塊大小。
left_chunk (int, 可選, 預設為 18) — 建立掩碼的左側塊。
dropout_rate (float, 可選, 預設為 0.0) — Dropout 比率。
ext_pw_out_channel (int, 可選, 預設為 1024) — 點式卷積模組中的輸出通道數。
depthwise_seperable_out_channel (int, 可選, 預設為 1024) — 深度可分離卷積模組中的輸出通道數。
depthwise_multiplier (int, 可選, 預設為 1) — 深度可分離卷積模組的輸入大小乘數。
kernel_size (int, 可選, 預設為 3) — 深度可分離卷積模組的核大小。
conv_activation (str, 可選, 預設為 "swish") — 卷積模組中的非線性啟用函式。
input_size (int, 可選, 預設為 80) — 音訊模型的輸入大小。
conv_glu_type (str, 可選, 預設為 "swish") — 點式卷積模組中的非線性啟用函式。
time_reduction (int, 可選, 預設為 8) — 時間縮減（下采樣因子）。
bias_max_distance (int, 可選, 預設為 1000) — 相對注意力偏差模組的最大距離。
bias_symmetric (bool, 可選, 預設為 False) — 相對注意力偏差是否應該對稱。
nemo_activation (str, 可選, 預設為 "relu") — nemo 卷積模組中的非線性啟用函式。
nemo_conv_channels (int, 可選, 預設為 1024) — nemo 卷積模組中的通道數。
downsample_rate (int, 可選, 預設為 1) — 音訊特徵提取器的下采樣率。
initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
audio_token_id (int, 可選, 預設為 200011) — 音訊標記 ID。
feature_layer (int, 可選, 預設為 -2) — 從編碼器中提取音訊特徵的層索引。

這是用於儲存 Phi4MultimodalAudioModel 配置的配置類。它用於根據指定的引數例項化 Phi4Multimodal 音訊編碼器，定義模型架構。使用預設值例項化配置將生成與 microsoft/Phi-4-multimodal-instruct 架構的音訊編碼器相似的配置。

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

示例

>>> from transformers import Phi4MultimodalAudioConfig

>>> # Initializing a Phi4MultimodalAudioConfig with microsoft/Phi-4-multimodal-instruct style configuration
>>> configuration = Phi4MultimodalAudioConfig()

Phi4MultimodalVisionConfig

class transformers.Phi4MultimodalVisionConfig

< source >

( hidden_size = 1152 intermediate_size = 4304 num_hidden_layers = 27 num_attention_heads = 16 num_channels = 3 image_size = 448 patch_size = 14 hidden_act = 'gelu_pytorch_tanh' layer_norm_eps = 1e-06 attention_dropout = 0.0 crop_size: int = 448 image_token_id: int = 200010 feature_layer: int = -2 **kwargs )

引數

hidden_size (int, 可選, 預設為 1152) — 編碼器層和池化器層的維度。
intermediate_size (int, 可選, 預設為 4304) — Transformer 編碼器中“中間”（即前饋）層的維度。
num_hidden_layers (int, 可選, 預設為 27) — Transformer 編碼器中的隱藏層數量。
num_attention_heads (int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數量。
num_channels (int, 可選, 預設為 3) — 輸入影像中的通道數。
image_size (int, 可選, 預設為 448) — 每張影像的大小（解析度）。
patch_size (int, 可選, 預設為 14) — 每個補丁的大小（解析度）。
hidden_act (str 或 function, 可選, 預設為 "gelu_pytorch_tanh") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果為字串，則支援 "gelu", "relu", "selu" 和 "gelu_new" "quick_gelu"。
layer_norm_eps (float, 可選, 預設為 1e-06) — 層歸一化層使用的 epsilon。
attention_dropout (float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
crop_size (int, 可選, 預設為 448) — 輸入影像的裁剪大小。
image_token_id (int, 可選, 預設為 200010) — 影像標記 ID。
feature_layer (int, 可選, 預設為 -2) — 從編碼器中提取影像特徵的層索引。

這是用於儲存 Phi4MultimodalVisionModel 配置的配置類。它用於根據指定的引數例項化 Phi4Multimodal 視覺編碼器，定義模型架構。使用預設值例項化配置將生成與 microsoft/Phi-4-multimodal-instruct 架構的視覺編碼器相似的配置。

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

示例

>>> from transformers import Phi4MultimodalVisionConfig

>>> # Initializing a Phi4MultimodalVisionConfig with microsoft/Phi-4-multimodal-instruct style configuration
>>> configuration = Phi4MultimodalVisionConfig()

Phi4MultimodalConfig

class transformers.Phi4MultimodalConfig

< source >

( vocab_size = 200064 hidden_size = 3072 intermediate_size = 8192 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 resid_pdrop = 0.0 embd_pdrop = 0.0 attention_dropout = 0.0 hidden_act = 'silu' max_position_embeddings = 131072 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 bos_token_id = 199999 eos_token_id = [199999, 200020] pad_token_id = 199999 original_max_position_embeddings = 4096 sliding_window = None vision_config = None audio_config = None **kwargs )

引數

vocab_size (int, 可選, 預設為 200064) — 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, 可選, 預設為 8) — 用於實現分組查詢注意力（Grouped Query Attention）的 key_value 頭數量。如果 num_key_value_heads=num_attention_heads，模型將使用多頭注意力（MHA），如果 num_key_value_heads=1，模型將使用多查詢注意力（MQA），否則使用 GQA。將多頭檢查點轉換為 GQA 檢查點時，每個組的 key 和 value 頭應該透過對該組內所有原始頭進行均值池化來構建。有關更多詳細資訊，請檢視這篇論文。如果未指定，將預設為 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, 可選, 預設為 131072) — 此模型可能使用的最大序列長度。
initializer_range (float, optional, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態分佈初始化器的標準差。
rms_norm_eps (float, optional, 預設為 1e-05) — 用於 RMSNorm 的 epsilon 值。
use_cache (bool, optional, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 config.is_decoder=True 時才相關。是否繫結權重嵌入。
tie_word_embeddings (bool, optional, 預設為 False) — 是否繫結權重嵌入
rope_theta (float, optional, 預設為 10000.0) — RoPE 嵌入的基礎週期。
rope_scaling (dict, optional) — RoPE 嵌入的縮放策略。如果為 None，則不應用縮放。如果為字典，則必須包含以下鍵：type、short_factor 和 long_factor。type 必須為 longrope，且 short_factor 和 long_factor 必須是數字列表，其長度與隱藏層大小除以注意力頭數再除以 2 相同。
partial_rotary_factor (float, optional, 預設為 1.0) — 將進行旋轉嵌入的查詢和鍵的百分比。必須介於 0.0 和 1.0 之間。
bos_token_id (int, optional, 預設為 199999) — “序列開始”標記的 ID。
eos_token_id (int 或 list[int], optional, 預設為 [199999, 200020]) — “序列結束”標記的 ID。
pad_token_id (int, optional, 預設為 199999) — 填充標記的 ID。
original_max_position_embeddings (int, optional, 預設為 4096) — 此模型訓練時使用的最大序列長度。當使用長縮放時，這用於確定原始 RoPE 嵌入的大小。
sliding_window (int, optional) — 滑動視窗注意力視窗大小。如果為 None，則不應用滑動視窗。
vision_config (Phi4MultimodalVisionConfig 或 dict, optional) — 底層影像嵌入模型的視覺配置。如果未提供，將預設為用於例項化與 microsoft/Phi-4-multimodal-instruct 架構相似的模型時使用的配置。
audio_config (Phi4MultimodalAudioConfig 或 dict, optional) — 底層音訊嵌入模型的音訊配置。如果未提供，將預設為用於例項化與 microsoft/Phi-4-multimodal-instruct 架構相似的模型時使用的配置。

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

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

示例

>>> from transformers import Phi4MultimodalModel, Phi4MultimodalConfig

>>> # Initializing a Phi4Multimodal style configuration
>>> configuration = Phi4MultimodalConfig.from_pretrained("microsoft/Phi-4-multimodal-instruct")

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

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

Phi4MultimodalAudioModel

class transformers.Phi4MultimodalAudioModel

< source >

( config: Phi4MultimodalAudioConfig )

forward_embeddings

< source >

( hidden_states masks )

透過頂部嵌入層轉發輸入

Phi4MultimodalVisionModel

class transformers.Phi4MultimodalVisionModel

< source >

( config: Phi4MultimodalVisionConfig )

Phi4MultimodalModel

class transformers.Phi4MultimodalModel

< source >

( config: Phi4MultimodalConfig )

引數

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

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

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

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

forward

< source >

( 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 image_pixel_values: typing.Optional[torch.FloatTensor] = None image_sizes: typing.Optional[torch.LongTensor] = None image_attention_mask = None audio_input_features: typing.Optional[torch.FloatTensor] = None audio_embed_sizes = None audio_attention_mask = 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 **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

引數

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

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

什麼是輸入 ID？
attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未遮蔽的標記，
- 0 表示已遮蔽的標記。
什麼是注意力掩碼？
position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 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) 元組，每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量）。這也被稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回傳統快取格式。

如果使用 past_key_values，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有將其過去的鍵值狀態提供給此模型的輸入 ID），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。
inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可選) — 可選地，除了傳入 input_ids，您還可以選擇直接傳入嵌入表示。如果您想對如何將 input_ids 索引轉換為相關向量比模型的內部嵌入查詢矩陣有更多的控制，這將很有用。
image_pixel_values (torch.FloatTensor, 可選) — 如果輸入包含影像，這些對應於轉換後的畫素值（由處理器返回）
image_sizes (torch.LongTensor, 可選) — 如果輸入包含影像，這些對應於每張影像的大小。
image_attention_mask (torch.LongTensor, 可選) — 影像的注意力掩碼。
audio_input_features (torch.FloatTensor, 可選) — 如果輸入包含音訊樣本，這些對應於轉換後的值（由處理器返回）。
audio_embed_sizes (torch.Tensor, 可選) — 音訊輸入的大小。
audio_attention_mask (`torch.Tensor, 可選) — 音訊輸入的注意力掩碼。
use_cache (bool, 可選) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的 attentions。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的 hidden_states。
cache_position (形狀為 (sequence_length) 的 torch.LongTensor, 可選) — 描述輸入序列標記在序列中的位置的索引。與 position_ids 不同，此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。

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

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

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每個層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

雖然前向傳播的實現需要在該函式中定義，但之後應呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。

Phi4MultimodalForCausalLM

class transformers.Phi4MultimodalForCausalLM

< source >

( config )

引數

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

用於因果語言建模的 Phi4 多模態模型。

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

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

forward

< source >

( 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 image_pixel_values: typing.Optional[torch.FloatTensor] = None image_sizes: typing.Optional[torch.LongTensor] = None image_attention_mask = None audio_input_features: typing.Optional[torch.FloatTensor] = None audio_embed_sizes = None audio_attention_mask = 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 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

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

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

什麼是輸入 ID？
attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未遮蔽的標記，
- 0 表示已遮蔽的標記。
什麼是注意力掩碼？
position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 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) 元組，每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量）。這也被稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回傳統快取格式。

如果使用 past_key_values，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有將其過去的鍵值狀態提供給此模型的輸入 ID），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。
inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可選) — 可選地，除了傳入 input_ids，您還可以選擇直接傳入嵌入表示。如果您想對如何將 input_ids 索引轉換為相關向量比模型的內部嵌入查詢矩陣有更多的控制，這將很有用。
image_pixel_values (torch.FloatTensor, 可選) — 如果輸入包含影像，這些對應於轉換後的畫素值（由處理器返回）
image_sizes (torch.LongTensor, 可選) — 如果輸入包含影像，這些對應於每張影像的大小。
image_attention_mask (torch.LongTensor, 可選) — 影像的注意力掩碼。
audio_input_features (torch.FloatTensor, 可選) — 如果輸入包含音訊樣本，這些對應於轉換後的值（由處理器返回）。
audio_embed_sizes (torch.Tensor, 可選) — 音訊輸入的大小。
audio_attention_mask (`torch.Tensor`, 可選) — 音訊輸入的注意力掩碼。
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 時），其中包含根據配置（Phi4MultimodalConfig）和輸入而定的各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每個層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

此為 Phi4MultimodalForCausalLM 的前向方法，覆蓋了 __call__ 特殊方法。

雖然前向傳播的實現需要在該函式中定義，但之後應呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。

示例

>>> from transformers import AutoTokenizer, Phi4MultimodalForCausalLM
>>> model = Phi4MultimodalForCausalLM.from_pretrained("TBA")
>>> tokenizer = AutoTokenizer.from_pretrained("TBA")
>>> prompt = "This is an example script ."
>>> 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]
'This is an example script .\n Certainly! Below is a sample script that demonstrates a simple task, such as calculating the sum'

< > 在 GitHub 上更新

Transformers

Phi4 多模態

概述

使用技巧

Phi4MultimodalFeatureExtractor

class transformers.Phi4MultimodalFeatureExtractor

Phi4MultimodalImageProcessorFast

class transformers.Phi4MultimodalImageProcessorFast

pad_to_max_num_crops

預處理

Phi4MultimodalProcessor

class transformers.Phi4MultimodalProcessor

batch_decode

解碼

Phi4MultimodalAudioConfig

class transformers.Phi4MultimodalAudioConfig

Phi4MultimodalVisionConfig

class transformers.Phi4MultimodalVisionConfig

Phi4MultimodalConfig

class transformers.Phi4MultimodalConfig

Phi4MultimodalAudioModel

class transformers.Phi4MultimodalAudioModel

forward_embeddings

Phi4MultimodalVisionModel

class transformers.Phi4MultimodalVisionModel

Phi4MultimodalModel

class transformers.Phi4MultimodalModel

forward

Phi4MultimodalForCausalLM

class transformers.Phi4MultimodalForCausalLM

forward