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 (...)"