Transformers 文件
Granite Vision
並獲得增強的文件體驗
開始使用
Granite Vision
概述
Granite Vision 模型是 LLaVA-NeXT 的變體,它利用了 Granite 語言模型和 SigLIP 視覺編碼器。它類似於 VipLlava,使用多個連線的視覺隱藏狀態作為其影像特徵。它還使用了比原始 LlaVa-NeXT 模型更大的一組影像網格精確點,以支援額外的縱橫比。
技巧
此模型作為 LlaVA-Next 的例項載入到 Transformers 中。來自 LLaVA-NeXT 的用法和提示也適用於此模型。
您也可以透過相同的方式將聊天模板應用於分詞器/處理器。示例聊天格式:
"<|user|>\nWhat’s shown in this image?\n<|assistant|>\nThis image shows a red stop sign.<|end_of_text|><|user|>\nDescribe the image in more details.\n<|assistant|>\n"
示例推理
from transformers import LlavaNextProcessor, LlavaNextForConditionalGeneration
model_path = "ibm-granite/granite-vision-3.1-2b-preview"
processor = LlavaNextProcessor.from_pretrained(model_path)
model = LlavaNextForConditionalGeneration.from_pretrained(model_path).to("cuda")
# prepare image and text prompt, using the appropriate prompt template
url = "https://github.com/haotian-liu/LLaVA/blob/1a91fc274d7c35a9b50b3cb29c4247ae5837ce39/images/llava_v1_5_radar.jpg?raw=true"
conversation = [
{
"role": "user",
"content": [
{"type": "image", "url": url},
{"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("cuda")
# autoregressively complete prompt
output = model.generate(**inputs, max_new_tokens=100)
print(processor.decode(output[0], skip_special_tokens=True))
此模型由 Alexander Brooks 貢獻。
LlavaNextConfig
class transformers.LlavaNextConfig
< source >( vision_config = None text_config = None image_token_index = 32000 projector_hidden_act = 'gelu' vision_feature_select_strategy = 'default' vision_feature_layer = -2 image_grid_pinpoints = None tie_word_embeddings = False image_seq_length = 576 multimodal_projector_bias = True **kwargs )
引數
- vision_config (
Union[AutoConfig, dict]
, optional, 預設為CLIPVisionConfig
) — 視覺骨幹的配置物件或字典。 - text_config (
Union[AutoConfig, dict]
, optional, 預設為LlamaConfig
) — 文字骨幹的配置物件或字典。 - image_token_index (
int
, optional, 預設為 32000) — 用於編碼影像提示的影像 token 索引。 - projector_hidden_act (
str
, optional, 預設為"gelu"
) — 多模態投影器使用的啟用函式。 - vision_feature_select_strategy (
str
, optional, 預設為"default"
) — 用於從視覺骨幹中選擇視覺特徵的特徵選擇策略。可以是"default"
或"full"
之一。如果為"default"
,則從視覺特徵中移除 CLS token。如果為"full"
,則使用完整的視覺特徵。 - vision_feature_layer (
Union[int, list[int]]
, optional, 預設為 -2) — 選擇視覺特徵的層索引。如果提供了多個索引,則相應索引的視覺特徵將連線起來形成視覺特徵。 - image_grid_pinpoints (
List
, optional, 預設為[[336, 672], [672, 336], [672, 672], [1008, 336], [336, 1008]]
) — 用於處理高解析度影像的可能解析度列表。列表中的每個項都應是(高度, 寬度)
形式的元組或列表。 - tie_word_embeddings (
bool
, optional, 預設為False
) — 模型的輸入和輸出詞嵌入是否應該繫結。 - image_seq_length (
int
, optional, 預設為 576) — 單個影像嵌入的序列長度。 - multimodal_projector_bias (
bool
, optional, 預設為True
) — 是否在多模態投影器中使用偏差。
這是用於儲存 LlavaNextForConditionalGeneration 配置的配置類。它用於根據指定的引數例項化 Llava-NeXT 模型,定義模型架構。使用預設值例項化配置將產生類似於 llava-hf/llava-v1.6-mistral-7b-hf 模型的配置。
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。有關更多資訊,請參閱 PretrainedConfig 的文件。
示例
>>> from transformers import LlavaNextForConditionalGeneration, LlavaNextConfig, CLIPVisionConfig, LlamaConfig
>>> # Initializing a CLIP-vision config
>>> vision_config = CLIPVisionConfig()
>>> # Initializing a Llama config
>>> text_config = LlamaConfig()
>>> # Initializing a Llava-Next llava-hf/llava-v1.6-mistral-7b-hf style configuration
>>> configuration = LlavaNextConfig(vision_config, text_config)
>>> # Initializing a model from the llava-hf/llava-v1.6-mistral-7b-hf style configuration
>>> model = LlavaNextForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
LlavaNextImageProcessor
class transformers.LlavaNextImageProcessor
< source >( do_resize: bool = True size: typing.Optional[dict[str, int]] = None image_grid_pinpoints: typing.Optional[list] = 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_pad: typing.Optional[bool] = True do_convert_rgb: bool = True **kwargs )
引數
- do_resize (
bool
, optional, 預設為True
) — 是否將影像的(高度,寬度)尺寸調整為指定的size
。可以透過preprocess
方法中的do_resize
覆蓋。 - size (
dict[str, int]
可選, 預設為{"shortest_edge" -- 224}
): 調整大小後的影像尺寸。影像的最短邊將調整為 size[“shortest_edge”],最長邊將保持輸入長寬比。可以透過preprocess
方法中的size
覆蓋。 - image_grid_pinpoints (
List
可選, 預設為[[672, 336], [336, 672], [672, 672], [336, 1008], [1008, 336]]
) — 用於處理高解析度影像的可能解析度列表。根據影像的原始大小選擇最佳解析度。可以透過preprocess
方法中的image_grid_pinpoints
覆蓋。 - resample (
PILImageResampling
, optional, 預設為Resampling.BICUBIC
) — 如果調整影像大小,則使用的重取樣濾波器。可以透過preprocess
方法中的resample
覆蓋。 - do_center_crop (
bool
, optional, 預設為True
) — 是否將影像中心裁剪為指定的crop_size
。可以透過preprocess
方法中的do_center_crop
覆蓋。 - crop_size (
dict[str, int]
可選, 預設為 224) — 應用center_crop
後的輸出影像大小。可以透過preprocess
方法中的crop_size
覆蓋。 - do_rescale (
bool
, optional, 預設為True
) — 是否按指定的比例rescale_factor
重新縮放影像。可以透過preprocess
方法中的do_rescale
覆蓋。 - rescale_factor (
int
orfloat
, optional, 預設為1/255
) — 如果重新縮放影像,則使用的比例因子。可以透過preprocess
方法中的rescale_factor
覆蓋。 - do_normalize (
bool
, optional, 預設為True
) — 是否歸一化影像。可以透過preprocess
方法中的do_normalize
覆蓋。 - image_mean (
float
orlist[float]
, optional, 預設為[0.48145466, 0.4578275, 0.40821073]
) — 如果歸一化影像,則使用的均值。這是一個浮點數或浮點數列表,其長度與影像中的通道數相同。可以透過preprocess
方法中的image_mean
引數覆蓋。 - image_std (
float
orlist[float]
, optional, 預設為[0.26862954, 0.26130258, 0.27577711]
) — 如果歸一化影像,則使用的標準差。這是一個浮點數或浮點數列表,其長度與影像中的通道數相同。可以透過preprocess
方法中的image_std
引數覆蓋。可以透過preprocess
方法中的image_std
引數覆蓋。 - do_pad (
bool
, optional, 預設為True
) — 是否填充影像。如果為True
,將把批次中的影像補丁維度填充到批次中最大補丁數量。填充將應用於底部和右側,並用零填充。 - do_convert_rgb (
bool
, optional, 預設為True
) — 是否將影像轉換為 RGB。
構建 LLaVa-NeXT 影像處理器。基於 CLIPImageProcessor,並結合了 LLaVa 論文 中解釋的用於處理高解析度影像的附加技術。
預處理
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None image_grid_pinpoints: typing.Optional[list] = None resample: 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_pad: typing.Optional[bool] = 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 )
引數
- images (
ImageInput
) — 要預處理的影像。期望單個或批次影像,畫素值範圍為 0 到 255。如果傳入的影像畫素值在 0 到 1 之間,請設定do_rescale=False
。 - do_resize (
bool
, optional, 預設為self.do_resize
) — 是否調整影像大小。 - size (
dict[str, int]
, optional, 預設為self.size
) — 調整大小後的影像尺寸。影像的最短邊將調整為 size[“shortest_edge”],最長邊將保持輸入長寬比。 - image_grid_pinpoints (
List
可選, 預設為self.image_grid_pinpoints
) — 用於處理高解析度影像的可能解析度列表。根據影像的原始大小選擇最佳解析度。 - resample (
int
, optional, 預設為self.resample
) — 如果調整影像大小,則使用的重取樣濾波器。這可以是列舉PILImageResampling
之一。僅當do_resize
設定為True
時有效。 - do_center_crop (
bool
, optional, 預設為self.do_center_crop
) — 是否中心裁剪影像。 - crop_size (
dict[str, int]
, optional, 預設為self.crop_size
) — 中心裁剪的大小。僅當do_center_crop
設定為True
時有效。 - do_rescale (
bool
, optional, 預設為self.do_rescale
) — 是否縮放影像。 - rescale_factor (
float
, optional, 預設為self.rescale_factor
) — 如果do_rescale
設定為True
,則按此縮放因子縮放影像。 - do_normalize (
bool
, optional, 預設為self.do_normalize
) — 是否歸一化影像。 - image_mean (
float
或list[float]
, optional, 預設為self.image_mean
) — 用於歸一化的影像平均值。僅在do_normalize
設定為True
時有效。 - image_std (
float
或list[float]
, optional, 預設為self.image_std
) — 用於歸一化的影像標準差。僅在do_normalize
設定為True
時有效。 - do_pad (
bool
, optional, 預設為self.do_pad
) — 是否對影像進行填充。如果為True
,將把批次中影像的補丁維度填充到批次中最大的補丁數量。填充將以零填充到底部和右側。 - do_convert_rgb (
bool
, optional, 預設為self.do_convert_rgb
) — 是否將影像轉換為 RGB。 - return_tensors (
str
或TensorType
, optional) — 返回張量的型別。可以是以下之一:- 未設定:返回
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 (
ChannelDimension
或str
, optional, 預設為ChannelDimension.FIRST
) — 輸出影像的通道維度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
:影像格式為 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
:影像格式為 (height, width, num_channels)。- 未設定:使用輸入影像的通道維度格式。
- input_data_format (
ChannelDimension
或str
, optional) — 輸入影像的通道維度格式。如果未設定,則從輸入影像推斷通道維度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
:影像格式為 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
:影像格式為 (height, width, num_channels)。"none"
或ChannelDimension.NONE
:影像格式為 (height, width)。
LlavaNextProcessor
class transformers.LlavaNextProcessor
< 來源 >( 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 (LlavaNextImageProcessor, optional) — 影像處理器是必需的輸入。
- tokenizer (LlamaTokenizerFast, optional) — 分詞器是必需的輸入。
- patch_size (
int
, optional) — 視覺塔的補丁大小。 - vision_feature_select_strategy (
str
, optional) — 用於從視覺骨幹網選擇視覺特徵的特徵選擇策略。應與模型的配置相同。 - chat_template (
str
, optional) — 一個 Jinja 模板,用於將聊天中的訊息列表轉換為可分詞的字串。 - image_token (
str
, optional, 預設為"<image>"
) — 用於表示影像位置的特殊標記。 - num_additional_image_tokens (
int
, optional, 預設為 0) — 新增到影像嵌入中的額外標記數量,例如 CLS (+1)。如果骨幹網沒有 CLS 或其他額外附加的標記,則無需設定此引數。
構建一個 LLaVa-NeXT 處理器,它將 LLaVa-NeXT 影像處理器和 LLaMa 分詞器封裝到一個處理器中。
LlavaNextProcessor 提供了 LlavaNextImageProcessor 和 LlamaTokenizerFast 的所有功能。有關更多資訊,請參閱 __call__()
和 decode()。
此方法將其所有引數轉發到 LlamaTokenizerFast 的 batch_decode()。有關更多資訊,請參閱此方法的文件字串。
LlavaNextForConditionalGeneration
class transformers.LlavaNextForConditionalGeneration
< 來源 >( config: LlavaNextConfig )
引數
- config (LlavaNextConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只加載配置。請檢視 from_pretrained() 方法載入模型權重。
LLAVA-NeXT 模型由一個視覺骨幹和一個語言模型組成。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< 來源 >( input_ids: LongTensor = None pixel_values: FloatTensor = None image_sizes: 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 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.llava_next.modeling_llava_next.KwargsForCausalLM] ) → transformers.models.llava_next.modeling_llava_next.LlavaNextCausalLMOutputWithPast
或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)
的torch.LongTensor
) — 詞彙表中輸入序列標記的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲取。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- pixel_values (形狀為
(batch_size, num_channels, image_size, image_size)
的torch.FloatTensor
) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}
獲取。有關詳細資訊,請參閱{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
處理影像)。 - image_sizes (形狀為
(batch_size, 2)
的torch.LongTensor
, optional) — 批次中影像的大小,每個影像為 (高度, 寬度)。 - attention_mask (形狀為
(batch_size, sequence_length)
的torch.Tensor
, optional) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示未被掩碼的標記,
- 0 表示被掩碼的標記。
- position_ids (形狀為
(batch_size, sequence_length)
的torch.LongTensor
, optional) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.n_positions - 1]
範圍內選擇。 - past_key_values (
list[torch.FloatTensor]
, optional) — 預先計算的隱藏狀態(自注意力塊和交叉注意力塊中的鍵和值),可用於加速順序解碼。這通常包括模型在解碼上一階段返回的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
(那些未將過去的鍵值狀態提供給此模型的)而不是形狀為(batch_size, sequence_length)
的所有input_ids
。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, optional) — 可選地,您可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果您想對如何將input_ids
索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這會很有用。 - vision_feature_layer (
Union[int, list[int], NoneType]
) — 選擇視覺特徵的層索引。如果提供了多個索引,則相應索引的視覺特徵將連線起來形成視覺特徵。 - vision_feature_select_strategy (
str
, optional, 預設為"default"
) — 用於從視覺骨幹網選擇視覺特徵的特徵選擇策略。可以是"default"
或"full"
之一。如果為"default"
,則從視覺特徵中刪除 CLS 標記。如果為"full"
,則使用完整的視覺特徵。 - labels (形狀為
(batch_size, sequence_length)
的torch.LongTensor
, optional) — 用於計算掩碼語言建模損失的標籤。索引應在[0, ..., config.vocab_size]
或 -100 之間(參見input_ids
文件字串)。索引設定為-100
的標記將被忽略(掩碼),損失僅針對標籤在[0, ..., config.vocab_size]
中的標記計算。 - use_cache (
bool
, optional) — 如果設定為True
,將返回past_key_values
鍵值狀態,可用於加速解碼(參見past_key_values
)。 - output_attentions (
bool
, optional) — 是否返回所有注意力層的注意力張量。有關詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
, optional) — 是否返回所有層的隱藏狀態。有關詳細資訊,請參閱返回張量下的hidden_states
。 - cache_position (形狀為
(sequence_length)
的torch.LongTensor
, optional) — 表示輸入序列標記在序列中位置的索引。與position_ids
不同,此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。 - logits_to_keep (
Union[int, torch.Tensor]
, 預設為0
) — 如果是int
,則計算最後logits_to_keep
個標記的 logits。如果是0
,則計算所有input_ids
的 logits(特殊情況)。生成時只需要最後一個標記的 logits,並且僅對該標記計算 logits 可以節省記憶體,這對於長序列或大詞彙表大小變得相當重要。如果是torch.Tensor
,則必須是與序列長度維度中要保留的索引相對應的 1D 張量。當使用打包張量格式(批次和序列長度為單一維度)時,這很有用。
返回
transformers.models.llava_next.modeling_llava_next.LlavaNextCausalLMOutputWithPast
或 tuple(torch.FloatTensor)
一個 transformers.models.llava_next.modeling_llava_next.LlavaNextCausalLMOutputWithPast
或一個 torch.FloatTensor
元組(如果傳遞了 return_dict=False
或 config.return_dict=False
),包含根據配置 (LlavaNextConfig) 和輸入的不同元素。
-
loss (
torch.FloatTensor
形狀為(1,)
,可選,當提供labels
時返回) — 語言建模損失(用於下一個 token 預測)。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)
的torch.FloatTensor
) — 語言建模頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。 -
past_key_values (
tuple(tuple(torch.FloatTensor))
, optional, 當傳遞use_cache=True
或config.use_cache=True
時返回) — 長度為config.n_layers
的tuple(torch.FloatTensor)
元組,每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)
的張量。包含預計算的隱藏狀態(自注意力塊中的鍵和值),可用於(參見
past_key_values
輸入)加速順序解碼。 -
hidden_states (
tuple[torch.FloatTensor]
, optional, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —torch.FloatTensor
元組(一個用於嵌入層輸出,如果模型有嵌入層,+ 每個層輸出一個),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple[torch.FloatTensor]
, optional, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) —torch.FloatTensor
元組(每個層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
-
image_hidden_states (
torch.FloatTensor
, optional) — 大小為 `(batch_size * num_patches, num_images, sequence_length, hidden_size)` 的torch.FloatTensor
。由視覺編碼器生成並投影最後一個隱藏狀態後的模型影像隱藏狀態。
LlavaNextForConditionalGeneration forward 方法會覆蓋 __call__
特殊方法。
雖然前向傳播的配方需要在此函式中定義,但在此之後應呼叫 Module
例項而不是此函式,因為前者負責執行預處理和後處理步驟,而後者則默默地忽略它們。
示例
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, LlavaNextForConditionalGeneration
>>> model = LlavaNextForConditionalGeneration.from_pretrained("llava-hf/llava-v1.6-mistral-7b-hf")
>>> processor = AutoProcessor.from_pretrained("llava-hf/llava-v1.6-mistral-7b-hf")
>>> prompt = "[INST] <image>\nWhat is shown in this image? [/INST]"
>>> 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_length=30)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"[INST] \nWhat is shown in this image? [/INST] The image appears to be a radar chart, which is a type of multi-dimensional plot (...)"