Transformers 文件

LLaVa

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

LLaVa

PyTorch FlashAttention SDPA

概述

LLaVa 是一個開源聊天機器人,透過在 GPT 生成的多模態指令遵循資料上對 LlamA/Vicuna 進行微調訓練而成。它是一個基於 Transformer 架構的自迴歸語言模型。換句話說,它是為聊天/指令微調的大語言模型 (LLM) 的多模態版本。

LLaVa 模型由 Haotian Liu、Chunyuan Li、Yuheng Li 和 Yong Jae Lee 在論文 Visual Instruction Tuning 中提出,並在 Improved Baselines with Visual Instruction Tuning 中進行了改進。

論文摘要如下:

大型多模態模型 (LMM) 最近在視覺指令微調方面取得了令人鼓舞的進展。在這篇說明中,我們展示了 LLaVA 中的全連線視覺-語言跨模態聯結器出人意料地強大且資料高效。透過對 LLaVA 進行簡單的修改,即使用帶有 MLP 投影的 CLIP-ViT-L-336px,並新增帶有簡單響應格式化提示的面向學術任務的 VQA 資料,我們建立了更強的基線,在 11 個基準測試中達到了最先進的水平。我們最終的 13B 檢查點僅使用了 120 萬個公開可用的資料,並在單個 8-A100 節點上約 1 天內完成全部訓練。我們希望這能讓最先進的 LMM 研究更容易普及。程式碼和模型將公開發布。

drawing LLaVa 架構。引自原始論文

該模型由 ArthurZybelkada 貢獻。原始程式碼可以在這裡找到。

使用技巧

  • 我們建議使用者在計算批生成時使用 padding_side="left",因為它能帶來更準確的結果。只需確保在生成前呼叫 processor.tokenizer.padding_side = "left"

  • 請注意,該模型並未經過明確訓練以處理同一提示中的多張影像,儘管技術上可行,但您可能會遇到不準確的結果。

[!NOTE] v4.46 版本之後釋出的 LLaVA 模型將引發關於新增 `processor.patch_size = {{patch_size}}`、`processor.num_additional_image_tokens = {{num_additional_image_tokens}}` 和 `processor.vision_feature_select_strategy = {{vision_feature_select_strategy}}` 的警告。強烈建議,如果您擁有模型檢查點,則向處理器新增這些屬性,如果它不屬於您,則提交一個 PR。新增這些屬性意味著 LLaVA 將嘗試推斷每張影像所需的影像標記數量,並用與標記數量一樣多的 `<image>` 佔位符來擴充套件文字。通常每張影像大約有 500 個標記,因此請確保文字沒有被截斷,否則在合併嵌入時會失敗。這些屬性可以從模型配置中獲取,例如 `model.config.vision_config.patch_size` 或 `model.config.vision_feature_select_strategy`。如果視覺骨幹網路添加了 CLS 標記,`num_additional_image_tokens` 應為 `1`;如果視覺補丁沒有新增任何額外內容,則應為 `0`。

使用聊天模板格式化提示

每個 **檢查點** 都經過特定提示格式的訓練,具體取決於底層大型語言模型骨幹。為確保格式正確,請使用處理器的 apply_chat_template 方法。

重要提示

  • 您必須構建一個對話歷史記錄——傳遞一個純字串將不起作用。
  • 每條訊息都應該是一個帶有 "role""content" 鍵的字典。
  • "content" 應該是一個包含不同模態(如 "text""image")的字典列表。

以下是如何構建輸入的示例。我們將使用 llava-hf/llava-1.5-7b-hf 以及一段文字和影像的對話歷史記錄。每個 content 欄位都必須是字典列表,如下所示:

from transformers import AutoProcessor

processor = AutoProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf")

conversation = [
    {
        "role": "user",
        "content": [
            {"type": "image"},
            {"type": "text", "text": "What’s shown in this image?"},
            ],
    },
    {
        "role": "assistant",
        "content": [{"type": "text", "text": "This image shows a red stop sign."},]
    },
    {

        "role": "user",
        "content": [
            {"type": "text", "text": "Describe the image in more details."},
        ],
    },
]

text_prompt = processor.apply_chat_template(conversation, add_generation_prompt=True)

# Note that the template simply formats your prompt, you still have to tokenize it and obtain pixel values for your images
print(text_prompt)
>>> "USER: <image>\n<What’s shown in this image? ASSISTANT: This image shows a red stop sign.</s>USER: Describe the image in more details. ASSISTANT:"
  • 如果您想自己構建聊天提示,下面是每個 llava 檢查點接受的提示格式列表。

llava-interleave 模型需要以下格式:

"<|im_start|>user <image>\nWhat is shown in this image?<|im_end|><|im_start|>assistant"

對於多輪對話:

"<|im_start|>user <image>\n<prompt1><|im_end|><|im_start|>assistant <answer1><|im_end|><|im_start|>user <image>\n<prompt1><|im_end|><|im_start|>assistant "

llava-1.5 模型需要以下格式:

"USER: <image>\n<prompt> ASSISTANT:"

對於多輪對話:

"USER: <image>\n<prompt1> ASSISTANT: <answer1></s>USER: <prompt2> ASSISTANT: <answer2></s>USER: <prompt3> ASSISTANT:"

🚀 福利: 如果您使用的是 transformers>=4.49.0,您還可以從 apply_chat_template 獲取向量化輸出。有關如何使用它的更多詳細資訊,請參閱下面的 使用示例

使用示例

單輸入推理

import torch
from transformers import AutoProcessor, LlavaForConditionalGeneration

# Load the model in half-precision
model = LlavaForConditionalGeneration.from_pretrained("llava-hf/llava-1.5-7b-hf", torch_dtype=torch.float16, device_map="auto")
processor = AutoProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf")

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

inputs = processor.apply_chat_template(
    conversation,
    add_generation_prompt=True,
    tokenize=True,
    return_dict=True,
    return_tensors="pt"
).to(model.device, torch.float16)

# Generate
generate_ids = model.generate(**inputs, max_new_tokens=30)
processor.batch_decode(generate_ids, skip_special_tokens=True)

批次推理

LLaVa 也支援批次推理。以下是操作方法:

import torch
from transformers import AutoProcessor, LlavaForConditionalGeneration

# Load the model in half-precision
model = LlavaForConditionalGeneration.from_pretrained("llava-hf/llava-1.5-7b-hf", torch_dtype=torch.float16, device_map="auto")
processor = AutoProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf")


# Prepare a batch of two prompts
conversation_1 = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "https://www.ilankelman.org/stopsigns/australia.jpg"},
            {"type": "text", "text": "What is shown in this image?"},
        ],
    },
]

conversation_2 = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "http://images.cocodataset.org/val2017/000000039769.jpg"},
            {"type": "text", "text": "What is shown in this image?"},
        ],
    },
]

inputs = processor.apply_chat_template(
    [conversation_1, conversation_2],
    add_generation_prompt=True,
    tokenize=True,
    return_dict=True,
    padding=True,
    return_tensors="pt"
).to(model.device, torch.float16)


# Generate
generate_ids = model.generate(**inputs, max_new_tokens=30)
processor.batch_decode(generate_ids, skip_special_tokens=True)

關於復現原始實現的說明

為了匹配原始實現的 logits,在例項化 `LlavaImageProcessor` 時需要額外指定 `do_pad=True`。

from transformers import LlavaImageProcessor

image_processor = LlavaImageProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf", do_pad=True)

使用 Flash Attention 2

Flash Attention 2 是先前最佳化的更快、更最佳化的版本,請參閱效能文件的 Flash Attention 2 部分

資源

Hugging Face 官方和社群(由 🌎 標誌表示)提供的資源列表,幫助您開始使用 BEiT。

影像到文字

LlavaConfig

class transformers.LlavaConfig

< >

( vision_config = None text_config = None image_token_index = 32000 projector_hidden_act = 'gelu' vision_feature_select_strategy = 'default' vision_feature_layer = -2 image_seq_length = 576 multimodal_projector_bias = True **kwargs )

引數

  • vision_config (Union[AutoConfig, dict], 可選, 預設為 CLIPVisionConfig) — 視覺骨幹網路的配置物件或字典。
  • text_config (Union[AutoConfig, dict], 可選, 預設為 LlamaConfig) — 文字骨幹網路的配置物件或字典。
  • image_token_index (int, 可選, 預設為 32000) — 用於編碼影像提示的影像標記索引。
  • projector_hidden_act (str, 可選, 預設為 "gelu") — 多模態投影器使用的啟用函式。
  • vision_feature_select_strategy (str, 可選, 預設為 "default") — 用於從視覺骨幹網路中選擇視覺特徵的特徵選擇策略。可以是 "default""full" 之一。
  • vision_feature_layer (Union[int, list[int]], 可選, 預設為 -2) — 用於選擇視覺特徵的層的索引。如果提供多個索引,相應索引的視覺特徵將被連線起來形成最終的視覺特徵。
  • image_seq_length (int, 可選, 預設為 576) — 單個影像嵌入的序列長度。
  • multimodal_projector_bias (bool, 可選, 預設為 True) — 是否在多模態投影器中使用偏置。

這是用於儲存 LlavaForConditionalGeneration 配置的配置類。它用於根據指定的引數例項化一個 Llava 模型,定義模型架構。使用預設值例項化一個配置將產生與 Llava-9B 類似的配置。

例如 llava-hf/llava-9b

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

示例

>>> from transformers import LlavaForConditionalGeneration, LlavaConfig, CLIPVisionConfig, LlamaConfig

>>> # Initializing a CLIP-vision config
>>> vision_config = CLIPVisionConfig()

>>> # Initializing a Llama config
>>> text_config = LlamaConfig()

>>> # Initializing a Llava llava-1.5-7b style configuration
>>> configuration = LlavaConfig(vision_config, text_config)

>>> # Initializing a model from the llava-1.5-7b style configuration
>>> model = LlavaForConditionalGeneration(configuration)

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

LlavaImageProcessor

class transformers.LlavaImageProcessor

< >

( do_pad: bool = False do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: typing.Optional[dict[str, int]] = None do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_convert_rgb: bool = True **kwargs )

引數

  • do_pad (bool, 可選, 預設為 False) — 是否根據最長邊將影像填充為正方形。填充值由 `image_mean` 引數確定。可在 `preprocess` 方法中透過 `do_pad` 覆蓋。
  • do_resize (bool, 可選, 預設為 True) — 是否將影像的 (高度, 寬度) 尺寸調整為指定的 `size`。可在 `preprocess` 方法中透過 `do_resize` 覆蓋。
  • size (dict[str, int] 可選, 預設為 {"shortest_edge" -- 224}): 調整大小後圖像的尺寸。影像的最短邊被調整為 size[“shortest_edge”],最長邊被調整以保持輸入寬高比。可在 `preprocess` 方法中透過 `size` 覆蓋。
  • resample (PILImageResampling, 可選, 預設為 Resampling.BICUBIC) — 如果調整影像大小,使用的重取樣濾波器。可在 `preprocess` 方法中透過 `resample` 覆蓋。
  • do_center_crop (bool, 可選, 預設為 True) — 是否將影像中心裁剪到指定的 `crop_size`。可在 `preprocess` 方法中透過 `do_center_crop` 覆蓋。
  • crop_size (dict[str, int] 可選, 預設為 224) — 應用 `center_crop` 後輸出影像的大小。可在 `preprocess` 方法中透過 `crop_size` 覆蓋。
  • do_rescale (bool, 可選, 預設為 True) — 是否透過指定的縮放因子 `rescale_factor` 重新縮放影像。可在 `preprocess` 方法中透過 `do_rescale` 覆蓋。
  • rescale_factor (intfloat, 可選, 預設為 1/255) — 如果重新縮放影像,使用的縮放因子。可在 `preprocess` 方法中透過 `rescale_factor` 覆蓋。
  • do_normalize (bool, 可選, 預設為 True) — 是否對影像進行歸一化。可在 `preprocess` 方法中透過 `do_normalize` 覆蓋。
  • image_mean (floatlist[float], 可選, 預設為 [0.48145466, 0.4578275, 0.40821073]) — 如果對影像進行歸一化,使用的均值。這是一個浮點數或浮點數列表,其長度等於影像中的通道數。可在 `preprocess` 方法中透過 `image_mean` 引數覆蓋。
  • image_std (floatlist[float]可選,預設為 [0.26862954, 0.26130258, 0.27577711]) — 用於影像歸一化的標準差。這是一個浮點數或浮點數列表,其長度等於影像中的通道數。該值可被 preprocess 方法中的 image_std 引數覆蓋。該值可被 preprocess 方法中的 image_std 引數覆蓋。
  • do_convert_rgb (bool可選,預設為 True) — 是否將影像轉換為 RGB。

構建一個 LLaVa 影像處理器。

preprocess

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_pad: typing.Optional[bool] = None do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: typing.Optional[PIL.Image.Resampling] = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[int] = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_convert_rgb: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Optional[transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None **kwargs )

引數

  • images (ImageInput) — 待預處理的影像。需要單個或一批畫素值範圍在 0 到 255 之間的影像。如果傳入的影像畫素值在 0 到 1 之間,請設定 do_rescale=False
  • do_pad (bool可選,預設為 self.do_pad) — 是否根據最長邊將影像填充成正方形。填充值由 image_mean 引數確定。
  • do_resize (bool可選,預設為 self.do_resize) — 是否調整影像大小。
  • size (dict[str, int]可選,預設為 self.size) — 調整大小後的影像尺寸。影像的最短邊將調整為 size["shortest_edge"],最長邊將相應調整以保持輸入影像的寬高比。
  • resample (int可選,預設為 self.resample) — 調整影像大小時使用的重取樣濾波器。可以是 PILImageResampling 列舉中的一個。僅在 do_resize 設定為 True 時生效。
  • do_center_crop (bool可選,預設為 self.do_center_crop) — 是否對影像進行中心裁剪。
  • crop_size (dict[str, int]可選,預設為 self.crop_size) — 中心裁剪的尺寸。僅在 do_center_crop 設定為 True 時生效。
  • do_rescale (bool可選,預設為 self.do_rescale) — 是否對影像進行縮放。
  • rescale_factor (float可選,預設為 self.rescale_factor) — 當 do_rescale 設定為 True 時,用於縮放影像的縮放因子。
  • do_normalize (bool可選,預設為 self.do_normalize) — 是否對影像進行歸一化。
  • image_mean (floatlist[float]可選,預設為 self.image_mean) — 用於歸一化的影像均值。僅在 do_normalize 設定為 True 時生效。
  • image_std (floatlist[float]可選,預設為 self.image_std) — 用於歸一化的影像標準差。僅在 do_normalize 設定為 True 時生效。
  • do_convert_rgb (bool可選,預設為 self.do_convert_rgb) — 是否將影像轉換為 RGB。
  • return_tensors (strTensorType可選) — 返回的張量型別。可以是以下之一:
    • 未設定:返回 np.ndarray 列表。
    • TensorType.TENSORFLOW'tf':返回一個 tf.Tensor 型別的批次。
    • TensorType.PYTORCH'pt':返回一個 torch.Tensor 型別的批次。
    • TensorType.NUMPY'np':返回一個 np.ndarray 型別的批次。
    • TensorType.JAX'jax':返回一個 jax.numpy.ndarray 型別的批次。
  • data_format (ChannelDimensionstr可選,預設為 ChannelDimension.FIRST) — 輸出影像的通道維度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:影像格式為 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:影像格式為 (height, width, num_channels)。
    • 未設定:使用輸入影像的通道維度格式。
  • input_data_format (ChannelDimensionstr可選) — 輸入影像的通道維度格式。如果未設定,則從輸入影像中推斷通道維度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:影像格式為 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:影像格式為 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:影像格式為 (height, width)。

預處理一張或一批影像。

LlavaImageProcessorFast

class transformers.LlavaImageProcessorFast

< >

( **kwargs: typing_extensions.Unpack[transformers.models.llava.image_processing_llava_fast.LlavaFastImageProcessorKwargs] )

構建一個快速的 Llava 影像處理器。

preprocess

< >

( 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.llava.image_processing_llava_fast.LlavaFastImageProcessorKwargs] ) <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可選) — 當 size 是整數時,調整大小時是否預設為正方形影像。
  • 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
  • do_pad (bool可選) — 是否根據最長邊將影像填充成正方形。

返回

<class 'transformers.image_processing_base.BatchFeature'>

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

LlavaProcessor

class transformers.LlavaProcessor

< >

( image_processor = None tokenizer = None patch_size = None vision_feature_select_strategy = None chat_template = None image_token = '<image>' num_additional_image_tokens = 0 **kwargs )

引數

  • image_processor (LlavaImageProcessor可選) — 影像處理器是必需的輸入。
  • tokenizer (LlamaTokenizerFast可選) — 分詞器是必需的輸入。
  • patch_size (int可選) — 視覺模型的補丁大小。
  • vision_feature_select_strategy (str可選) — 用於從視覺主幹中選擇視覺特徵的特徵選擇策略。應與模型配置中的設定相同。
  • chat_template (str可選) — 一個 Jinja 模板,用於將聊天中的訊息列表轉換為可分詞的字串。
  • image_token (str可選,預設為 "<image>") — 用於表示影像位置的特殊標記。
  • num_additional_image_tokens (int可選,預設為 0) — 新增到影像嵌入中的額外標記數量,例如 CLS (+1)。如果主幹模型沒有 CLS 或其他附加標記,則無需設定此引數。

構建一個 LLaVa 處理器,它將 LLaVa 影像處理器和 LLaMa 分詞器包裝成一個單一的處理器。

LlavaProcessor 提供了 LlavaImageProcessorLlamaTokenizerFast 的所有功能。更多資訊請參見 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法將其所有引數轉發給 LlamaTokenizerFast 的 batch_decode()。請參閱該方法的文件字串以獲取更多資訊。

decode

< >

( *args **kwargs )

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

LlavaModel

class transformers.LlavaModel

< >

( config: LlavaConfig )

引數

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

Llava 模型,由一個視覺主幹網路和一個語言模型組成,不帶語言模型頭。

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

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: LongTensor = None pixel_values: FloatTensor = 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 vision_feature_layer: typing.Union[int, list[int], NoneType] = None vision_feature_select_strategy: typing.Optional[str] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None image_sizes: Tensor = None **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) transformers.models.llava.modeling_llava.LlavaModelOutputWithPasttuple(torch.FloatTensor)

引數

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

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

    什麼是 input ID?

  • pixel_values (torch.FloatTensor,形狀為 (batch_size, num_channels, image_size, image_size)) — 對應於輸入影像的張量。可以使用 {image_processor_class} 獲取畫素值。有關詳細資訊,請參閱 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 處理影像)。
  • 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 ID?

  • past_key_values (list[torch.FloatTensor]可選) — 預計算的隱藏狀態(自注意力和交叉注意力塊中的鍵和值),可用於加速序列解碼。這通常包括模型在解碼的先前階段返回的 past_key_values,此時 use_cache=Trueconfig.use_cache=True

    允許兩種格式:

    • Cache 例項,請參閱我們的 kv cache 指南
    • 長度為 config.n_layerstuple(torch.FloatTensor) 的元組,每個元組包含 2 個形狀為 (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 索引轉換為關聯向量,這會很有用。
  • vision_feature_layer (Union[int, list[int], NoneType]) — 用於選擇視覺特徵的層索引。如果提供多個索引,則相應索引的視覺特徵將被連線以形成視覺特徵。
  • vision_feature_select_strategy (str可選) — 用於從視覺主幹網路中選擇視覺特徵的特徵選擇策略。可以是 "default""full"
  • use_cache (bool可選) — 如果設定為 True,將返回 past_key_values 鍵值狀態,可用於加速解碼(請參閱 past_key_values)。
  • output_attentions (bool可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 attentions
  • output_hidden_states (bool可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 hidden_states
  • return_dict (bool可選) — 是否返回 ModelOutput 而不是普通元組。
  • cache_position (torch.LongTensor,形狀為 (sequence_length)可選) — 描述輸入序列標記在序列中位置的索引。與 position_ids 不同,此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
  • image_sizes (torch.Tensor,形狀為 (batch_size, 2)) — 批次中影像的大小,每個影像為(高度,寬度)。

返回

transformers.models.llava.modeling_llava.LlavaModelOutputWithPasttuple(torch.FloatTensor)

一個 transformers.models.llava.modeling_llava.LlavaModelOutputWithPast 或一個 torch.FloatTensor 的元組(如果傳遞了 return_dict=Falseconfig.return_dict=False),根據配置(LlavaConfig)和輸入,包含各種元素。

  • last_hidden_state (形狀為 (batch_size, sequence_length, hidden_size)torch.FloatTensor, 可選) — 模型最後一層輸出的隱藏狀態序列。

  • past_key_values (tuple(tuple(torch.FloatTensor))可選,當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layerstuple(torch.FloatTensor) 元組,每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。

    包含預計算的隱藏狀態(自注意力塊中的鍵和值),可用於(參見 past_key_values 輸入)加速順序解碼。

  • hidden_states (tuple[torch.FloatTensor, ...]可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — `torch.FloatTensor` 的元組(一個用於嵌入層的輸出(如果模型有嵌入層),+ 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple[torch.FloatTensor, ...]可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — `torch.FloatTensor` 的元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • image_hidden_states (torch.FloatTensor可選) — 一個大小為 (batch_size, num_images, sequence_length, hidden_size)torch.FloatTensor。模型由視覺編碼器生成並投影最後一個隱藏狀態後的 image_hidden_states。

LlavaModel 的 forward 方法會覆蓋 __call__ 特殊方法。

雖然前向傳播的配方需要在此函式中定義,但之後應呼叫 Module 例項而不是此函式,因為前者會處理執行前處理和後處理步驟,而後者會默默地忽略它們。

get_image_features

< >

( pixel_values: FloatTensor vision_feature_layer: typing.Union[int, list[int], NoneType] = None vision_feature_select_strategy: typing.Optional[str] = None **kwargs ) image_features (torch.Tensor)

引數

  • pixel_values (torch.FloatTensor],形狀為 (batch_size, channels, height, width)) — 對應於輸入影像的張量。
  • vision_feature_layer (Union[int, list[int]]可選) — 用於選擇視覺特徵的層索引。如果提供多個索引,則相應索引的視覺特徵將被連線以形成視覺特徵。
  • vision_feature_select_strategy (str可選) — 用於從視覺主幹網路中選擇視覺特徵的特徵選擇策略。可以是 "default""full"

返回

image_features (torch.Tensor)

形狀為 (num_images, image_length, embed_dim) 的影像特徵張量。

從視覺塔獲取影像最後隱藏狀態並應用多模態投影。

LlavaForConditionalGeneration

class transformers.LlavaForConditionalGeneration

< >

( config: LlavaConfig )

引數

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

LLAVA 模型,由一個視覺主幹網路和一個語言模型組成。

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

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: LongTensor = None pixel_values: FloatTensor = 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 vision_feature_layer: typing.Union[int, list[int], NoneType] = None vision_feature_select_strategy: typing.Optional[str] = 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 return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 image_sizes: typing.Optional[torch.Tensor] = None **kwargs: typing_extensions.Unpack[transformers.models.llava.modeling_llava.KwargsForCausalLM] ) transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPasttuple(torch.FloatTensor)

引數

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

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

    什麼是 input ID?

  • pixel_values (torch.FloatTensor,形狀為 (batch_size, num_channels, image_size, image_size)) — 對應於輸入影像的張量。可以使用 {image_processor_class} 獲取畫素值。有關詳細資訊,請參閱 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 處理影像)。
  • 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 ID?

  • past_key_values (list[torch.FloatTensor]可選) — 預計算的隱藏狀態(自注意力和交叉注意力塊中的鍵和值),可用於加速序列解碼。這通常包括模型在解碼的先前階段返回的 past_key_values,此時 use_cache=Trueconfig.use_cache=True

    允許兩種格式:

    • Cache 例項,請參閱我們的 kv cache 指南
    • 長度為 config.n_layerstuple(torch.FloatTensor) 的元組,每個元組包含 2 個形狀為 (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 索引轉換為關聯向量,這會很有用。
  • vision_feature_layer (Union[int, list[int], NoneType]) — 用於選擇視覺特徵的層索引。如果提供多個索引,則相應索引的視覺特徵將被連線以形成視覺特徵。
  • vision_feature_select_strategy (str可選) — 用於從視覺主幹網路中選擇視覺特徵的特徵選擇策略。可以是 "default""full"
  • 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
  • return_dict (bool可選) — 是否返回 ModelOutput 而不是普通元組。
  • 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,則必須是一維的,對應於序列長度維度中要保留的索引。這在使用打包張量格式(批次和序列長度使用單一維度)時很有用。
  • image_sizes (torch.Tensor,形狀為 (batch_size, 2)可選) — 批次中影像的大小,每個影像為(高度,寬度)。

返回

transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPasttuple(torch.FloatTensor)

一個 transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPast 或一個 torch.FloatTensor 的元組(如果傳遞了 return_dict=Falseconfig.return_dict=False),根據配置(LlavaConfig)和輸入,包含各種元素。

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

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 語言建模頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可選,當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layerstuple(torch.FloatTensor) 元組,每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。

    包含預計算的隱藏狀態(自注意力塊中的鍵和值),可用於(參見 past_key_values 輸入)加速順序解碼。

  • hidden_states (tuple[torch.FloatTensor]可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — `torch.FloatTensor` 的元組(一個用於嵌入層的輸出(如果模型有嵌入層),+ 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple[torch.FloatTensor]可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — `torch.FloatTensor` 的元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • image_hidden_states (torch.FloatTensor可選) — 一個大小為 (batch_size, num_images, sequence_length, hidden_size)torch.FloatTensor。模型由視覺編碼器生成並投影最後一個隱藏狀態後的 image_hidden_states。

LlavaForConditionalGeneration 的 forward 方法會覆蓋 __call__ 特殊方法。

雖然前向傳播的配方需要在此函式中定義,但之後應呼叫 Module 例項而不是此函式,因為前者會處理執行前處理和後處理步驟,而後者會默默地忽略它們。

示例

>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, LlavaForConditionalGeneration

>>> model = LlavaForConditionalGeneration.from_pretrained("llava-hf/llava-1.5-7b-hf")
>>> processor = AutoProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf")

>>> prompt = "USER: <image>\nWhat's the content of the image? ASSISTANT:"
>>> url = "https://www.ilankelman.org/stopsigns/australia.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = processor(images=image, text=prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(**inputs, max_new_tokens=15)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"USER:  \nWhat's the content of the image? ASSISTANT: The image features a busy city street with a stop sign prominently displayed"
< > 在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.