Transformers 文档
LLaVa
并获得增强的文档体验
开始使用
LLaVa
概述
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 研究更容易普及。代码和模型将公开发布。

该模型由 ArthurZ 和 ybelkada 贡献。原始代码可以在这里找到。
使用技巧
我们建议用户在计算批生成时使用
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。
- 一个Google Colab 演示,展示如何利用 4 位推理在免费的 Google Colab 实例上运行 Llava。
- 一个类似的 notebook,展示了批量推理。🌎
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 类似的配置。
配置对象继承自 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 (
int
或float
, 可选, 默认为1/255
) — 如果重新缩放图像,使用的缩放因子。可在 `preprocess` 方法中通过 `rescale_factor` 覆盖。 - do_normalize (
bool
, 可选, 默认为True
) — 是否对图像进行归一化。可在 `preprocess` 方法中通过 `do_normalize` 覆盖。 - image_mean (
float
或list[float]
, 可选, 默认为[0.48145466, 0.4578275, 0.40821073]
) — 如果对图像进行归一化,使用的均值。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可在 `preprocess` 方法中通过 `image_mean` 参数覆盖。 - image_std (
float
或list[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 (
float
或list[float]
,可选,默认为self.image_mean
) — 用于归一化的图像均值。仅在do_normalize
设置为True
时生效。 - image_std (
float
或list[float]
,可选,默认为self.image_std
) — 用于归一化的图像标准差。仅在do_normalize
设置为True
时生效。 - do_convert_rgb (
bool
,可选,默认为self.do_convert_rgb
) — 是否将图像转换为 RGB。 - return_tensors (
str
或TensorType
,可选) — 返回的张量类型。可以是以下之一:- 未设置:返回
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
,可选,默认为ChannelDimension.FIRST
) — 输出图像的通道维度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
:图像格式为 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
:图像格式为 (height, width, num_channels)。- 未设置:使用输入图像的通道维度格式。
- input_data_format (
ChannelDimension
或str
,可选) — 输入图像的通道维度格式。如果未设置,则从输入图像中推断通道维度格式。可以是以下之一:"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 提供了 LlavaImageProcessor 和 LlamaTokenizerFast 的所有功能。更多信息请参见 __call__()
和 decode()。
此方法将其所有参数转发给 LlamaTokenizerFast 的 batch_decode()。请参阅该方法的文档字符串以获取更多信息。
此方法将其所有参数转发给 LlamaTokenizerFast 的 decode()。有关更多信息,请参阅此方法的文档字符串。
LlavaModel
class transformers.LlavaModel
< source >( config: LlavaConfig )
参数
- config (LlavaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Llava 模型,由一个视觉主干网络和一个语言模型组成,不带语言模型头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( 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.LlavaModelOutputWithPast
或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]
。 - past_key_values (
list[torch.FloatTensor]
,可选) — 预计算的隐藏状态(自注意力和交叉注意力块中的键和值),可用于加速序列解码。这通常包括模型在解码的先前阶段返回的past_key_values
,此时use_cache=True
或config.use_cache=True
。允许两种格式:
- Cache 实例,请参阅我们的 kv cache 指南;
- 长度为
config.n_layers
的tuple(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.LlavaModelOutputWithPast
或 tuple(torch.FloatTensor)
一个 transformers.models.llava.modeling_llava.LlavaModelOutputWithPast
或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),根据配置(LlavaConfig)和输入,包含各种元素。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可选) — 模型最后一层输出的隐藏状态序列。 -
past_key_values (
tuple(tuple(torch.FloatTensor))
,可选,当传递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, ...]
,可选,当传递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 后的注意力权重,用于计算自注意力头中的加权平均值。
-
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
< source >( 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
< source >( config: LlavaConfig )
参数
- config (LlavaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
LLAVA 模型,由一个视觉主干网络和一个语言模型组成。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( 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.LlavaCausalLMOutputWithPast
或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]
。 - past_key_values (
list[torch.FloatTensor]
,可选) — 预计算的隐藏状态(自注意力和交叉注意力块中的键和值),可用于加速序列解码。这通常包括模型在解码的先前阶段返回的past_key_values
,此时use_cache=True
或config.use_cache=True
。允许两种格式:
- Cache 实例,请参阅我们的 kv cache 指南;
- 长度为
config.n_layers
的tuple(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.LlavaCausalLMOutputWithPast
或 tuple(torch.FloatTensor)
一个 transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPast
或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.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=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]
,可选,当传递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 后的注意力权重,用于计算自注意力头中的加权平均值。
-
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"