Transformers 文档

LLaVa-NeXT-Video

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

LLaVa-NeXT-视频

PyTorch FlashAttention SDPA

概述

LLaVa-NeXT-Video 模型由 Yuanhan Zhang, Bo Li, Haotian Liu, Yong Jae Lee, Liangke Gui, Di Fu, Jiashi Feng, Ziwei Liu, Chunyuan Li 在 LLaVA-NeXT: 一个强大的零样本视频理解模型 中提出。LLaVa-NeXT-Video 通过在视频和图像数据集上进行混合微调,从而提高了模型在视频上的性能,以改进 LLaVa-NeXT

LLaVA-NeXT 令人惊讶地在零样本视频内容理解方面表现出色,这得益于其使用的 AnyRes 技术。AnyRes 技术自然地将高分辨率图像表示为多个图像。这种技术自然地可以推广到表示视频,因为视频可以被视为一组帧(类似于 LLaVa-NeXT 中的一组图像)。LLaVA-NeXT 的当前版本利用 AnyRes,并在 LLaVA-Next 的基础上对视频数据进行监督微调 (SFT) 训练,以实现更好的视频理解能力。该模型目前在 VideoMME 基准 上是开源模型中的最新 SOTA。

博客中的引言如下:

2024 年 1 月 30 日,我们发布了 LLaVA-NeXT,一个完全在文本-图像数据上训练的开源大型多模态模型 (LMM)。凭借所提出的 AnyRes 技术,它提升了推理、OCR 和世界知识方面的能力,在各种基于图像的多模态理解任务中表现出色,甚至在 MMMU 和 MathVista 等多个图像基准上超越了 Gemini-Pro。

**在今天的探索中,我们深入研究了 LLaVA-NeXT 在视频理解任务领域的性能。我们发现 LLaVA-NeXT 在理解视频内容方面表现出令人惊讶的强大性能。当前版本的 LLaVA-NeXT 针对视频有以下几项改进:

  • AnyRes 的零样本视频表示能力:AnyRes 技术自然地将高分辨率图像表示为多个图像,这些图像可以被预训练的 VIT 处理,并形成一个连接序列。这项技术自然地可以推广到表示视频(由多个帧组成),使得仅在图像上训练的 LLaVA-Next 模型在视频任务上表现出令人惊讶的良好性能。值得注意的是,这是 LMM 首次展示出强大的零样本模态迁移能力。
  • 通过长度泛化进行的推理在更长的视频上得到改进。线性缩放技术实现了长度泛化,使得 LLaVA-NeXT 能够有效处理超出 LLM “max_token_length” 限制的长视频。
  • 强大的视频理解能力。(1) LLaVA-Next-Image 结合了上述两种技术,在零样本性能方面优于在视频上微调的开源 LMM。(2) LLaVA-Next-Video 通过在视频数据上进一步监督微调 (SFT) LLaVA-Next-Image,实现了比 LLaVA-Next-Image 更好的视频理解能力。(3) LLaVA-Next-Video-DPO,它使用直接偏好优化 (DPO) 将模型响应与 AI 反馈对齐,显示出显著的性能提升。
  • 使用 SGLang 进行高效部署和推理。它使视频任务的推理速度提高了 5 倍,从而可以进行更具可扩展性的服务,例如百万级别的视频重字幕。请参阅我们仓库中的说明。**

此模型由 RaushanTurganbay 贡献。原始代码可在 此处 找到。

使用技巧

  • 我们建议用户在计算批生成时使用 padding_side="left",因为它能带来更准确的结果。只需确保在生成前调用 processor.tokenizer.padding_side = "left"
  • Llava-Next 对图像使用不同数量的补丁,因此除了在处理输入时进行的填充之外,还必须在建模代码内部填充输入。如果模型处于 eval() 模式,默认设置为“左填充”,否则为“右填充”。

[!注意] 版本 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_sizemodel.config.vision_feature_select_strategy。如果视觉骨干添加了 CLS 标记,则 num_additional_image_tokens 应为 1;如果没有添加额外内容到视觉补丁,则为 0

使用聊天模板格式化提示

每个 **检查点** 都经过特定提示格式的训练,具体取决于底层大型语言模型骨干。为确保格式正确,请使用处理器的 apply_chat_template 方法。

重要提示

  • 您必须构建一个对话历史记录——传递一个纯字符串将不起作用。
  • 每条消息都应该是一个带有 "role""content" 键的字典。
  • "content" 应该是一个包含不同模态(如 "text""image")的字典列表。

以下是如何构建输入的一个示例。我们将使用 LLaVA-NeXT-Video-7B-hf 以及视频和图像的对话历史。

from transformers import LlavaNextVideoProcessor

processor = LlavaNextVideoProcessor.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf")

conversation = [
    {
        "role": "system",
        "content": [
            {"type": "text", "text": "A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions."},
            ],
    },
    {
        "role": "user",
        "content": [
            {"type": "text", "text": "What’s shown in this image?"},
            {"type": "image"},
            ],
    },
    {
        "role": "assistant",
        "content": [{"type": "text", "text": "This image shows a red stop sign."},]
    },
    {

        "role": "user",
        "content": [
            {"type": "text", "text": "Why is this video funny?"},
            {"type": "video"},
            ],
    },
]

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 visuals
print(text_prompt)

🚀 福利: 如果您使用的是 transformers>=4.49.0,您还可以从 apply_chat_template 获取矢量化输出。有关如何使用它的更多详细信息,请参阅下面的 使用示例

使用示例

单媒体模式

该模型可以接受图像和视频作为输入。以下是半精度推理(torch.float16)的示例代码

from huggingface_hub import hf_hub_download
import torch
from transformers import LlavaNextVideoForConditionalGeneration, LlavaNextVideoProcessor

# Load the model in half-precision
model = LlavaNextVideoForConditionalGeneration.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf", torch_dtype=torch.float16, device_map="auto")
processor = LlavaNextVideoProcessor.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf")

# Load the video as an np.array, sampling uniformly 8 frames (can sample more for longer videos)
video_path = hf_hub_download(repo_id="raushan-testing-hf/videos-test", filename="sample_demo_1.mp4", repo_type="dataset")

conversation = [
    {

        "role": "user",
        "content": [
            {"type": "text", "text": "Why is this video funny?"},
            {"type": "video", "path": video_path},
            ],
    },
]

inputs = processor.apply_chat_template(conversation, num_frames=8, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt")

out = model.generate(**inputs, max_new_tokens=60)
processor.batch_decode(out, skip_special_tokens=True, clean_up_tokenization_spaces=True)

混合媒体模式

该模型还可以从交错的图像-视频输入中生成。但请注意,它未在交错的图像-视频设置中进行训练,这可能会影响性能。以下是混合媒体输入的使用示例,将以下行添加到上述代码片段中


# Generate from image and video mixed inputs
conversation = [
    {

        "role": "user",
        "content": [
            {"type": "text", "text": "How many cats are there in the image?"},
            {"type": "image", "url": "http://images.cocodataset.org/val2017/000000039769.jpg"},
            ],
    },
    {

        "role": "assistant",
        "content": [{"type": "text", "text": "There are two cats"}],
    },
    {

        "role": "user",
        "content": [
            {"type": "text", "text": "Why is this video funny?"},
            {"type": "video", "path": video_path},
            ],
    },
]
inputs = processor.apply_chat_template(conversation, num_frames=8, add_generation_prompt=True, tokenize=True, return_dict=True, padding=True, return_tensors="pt")

# Generate
generate_ids = model.generate(**inputs, max_length=50)
processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=True)

模型优化

使用 Bitsandbytes 进行量化以提高内存效率

该模型可以以较低的位加载,显著减少内存负担,同时保持原始模型的性能。这使得在资源受限的情况下可以高效部署。

首先,请确保通过运行 pip install bitsandbytes 来安装 bitsandbytes,并且可以访问该库支持的 GPU/加速器。

bitsandbytes 正在重构以支持 CUDA 以外的多个后端。目前,ROCm (AMD GPU) 和 Intel CPU 实现已成熟,Intel XPU 正在进行中,预计在第四季度/第一季度支持 Apple Silicon。有关安装说明和最新后端更新,请访问 此链接

我们重视您的反馈,以帮助在完整发布之前发现错误!请查看 这些文档 获取更多详细信息和反馈链接。

然后,只需通过添加 BitsAndBytesConfig 加载量化模型,如下所示

from transformers import LlavaNextVideoForConditionalGeneration, LlavaNextVideoProcessor

# specify how to quantize the model
quantization_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_compute_dtype=torch.float16,
)

model = LlavaNextVideoForConditionalGeneration.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf", quantization_config=quantization_config, device_map="auto")

Flash-Attention 2 加速生成

此外,我们可以通过使用 Flash Attention 大幅加速模型推理,它是模型内部注意力机制的更快实现。

首先,请确保安装最新版本的 Flash Attention 2

pip install -U flash-attn --no-build-isolation

此外,您应该拥有与 Flash-Attention 2 兼容的硬件。有关更多信息,请参阅 Flash Attention 仓库 的官方文档。FlashAttention-2 只能在模型以 torch.float16torch.bfloat16 加载时使用。

要使用 Flash Attention-2 加载和运行模型,只需在加载模型时添加 `attn_implementation="flash_attention_2"`,如下所示

from transformers import LlavaNextVideoForConditionalGeneration

model = LlavaNextVideoForConditionalGeneration.from_pretrained(
    "llava-hf/LLaVA-NeXT-Video-7B-hf", 
    torch_dtype=torch.float16, 
    attn_implementation="flash_attention_2",
).to(0)

LlavaNextVideoConfig

class transformers.LlavaNextVideoConfig

< >

( vision_config = None text_config = None image_token_index = 32001 projector_hidden_act = 'gelu' multimodal_projector_bias = True vision_feature_select_strategy = 'default' vision_feature_layer = -2 image_grid_pinpoints = None tie_word_embeddings = False video_token_index = 32000 spatial_pool_mode = 'average' spatial_pool_stride = 2 image_seq_length = 576 video_seq_length = 288 **kwargs )

参数

  • vision_config (Union[AutoConfig, dict], 可选, 默认为 CLIPVisionConfig) — 视觉骨干的配置对象或字典。
  • text_config (Union[AutoConfig, dict], 可选, 默认为 LlamaConfig) — 文本骨干的配置对象或字典。
  • image_token_index (int, 可选, 默认为 32001) — 用于编码图像提示的图像标记索引。
  • projector_hidden_act (str, 可选, 默认为 "gelu") — 多模态投影器使用的激活函数。
  • multimodal_projector_bias (bool, 可选, 默认为 True) — 是否在多模态投影器中使用偏差。
  • vision_feature_select_strategy (str, 可选, 默认为 "default") — 用于从视觉骨干中选择视觉特征的特征选择策略。可以是 "default""full"。如果为 "default",则从视觉特征中删除 CLS 标记。如果为 "full",则使用完整的视觉特征。
  • vision_feature_layer (Union[int, list[int]], 可选, 默认为 -2) — 选择视觉特征的层索引。如果提供了多个索引,则相应索引的视觉特征将被连接起来形成视觉特征。
  • image_grid_pinpoints (List, 可选, 默认为 [[336, 672], [672, 336], [672, 672], [1008, 336], [336, 1008]]) — 用于处理高分辨率图像的可能分辨率列表。列表中的每个项都应为 (height, width) 形式的元组或列表。
  • tie_word_embeddings (bool, 可选, 默认为 False) — 模型的输入和输出词嵌入是否应该绑定。
  • video_token_index (int, 可选, 默认为 32000) — 用于编码图像提示的视频标记索引。
  • spatial_pool_mode (str, 可选, 默认为 "average") — 用于视频的池化模式。可以是“average”、“max”或“conv”。
  • spatial_pool_stride (int, 可选, 默认为 2) — 视频池化层中使用的步幅。
  • image_seq_length (int, 可选, 默认为 576) — 单个图像嵌入的序列长度。
  • video_seq_length (int, 可选, 默认为 288) — 单个视频嵌入的序列长度。

这是一个配置类,用于存储 LlavaNextVideoForConditionalGeneration 的配置。它用于根据指定的参数实例化 Llava-NeXT 模型,定义模型架构。使用默认值实例化配置将产生与 llava-hf/LLaVA-NeXT-Video-7B-hf 模型相似的配置。配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import LlavaNextVideoForConditionalGeneration, LlavaNextVideoConfig, CLIPVisionConfig, LlamaConfig

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

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

>>> configuration = LlavaNextVideoConfig(vision_config, text_config)

>>> model = LlavaNextVideoForConditionalGeneration(configuration)

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

LlavaNextVideoProcessor

class transformers.LlavaNextVideoProcessor

< >

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

参数

  • video_processor (LlavaNextVideoProcessor, 可选) — 视频处理器是一个必需的输入。
  • image_processor (LlavaNextImageProcessor, 可选) — 图像处理器是一个必需的输入。
  • tokenizer (LlamaTokenizerFast, 可选) — 分词器是一个必需的输入。
  • chat_template (str, 可选) — 将在分词器的 apply_chat_template 中使用的 Jinja 聊天模板
  • patch_size (int, 可选) — 来自视觉塔的补丁大小。
  • vision_feature_select_strategy (str, 可选) — 用于从视觉骨干中选择视觉特征的特征选择策略。应与模型配置中的相同。
  • video_token (str, 可选, 默认为 "<video>") — 用于表示视频位置的特殊标记。
  • image_token (str, 可选, 默认为 "<image>") — 用于表示图像位置的特殊标记。
  • num_additional_image_tokens (int, 可选, 默认为 0) — 添加到图像嵌入的附加标记数量,例如 CLS (+1)。如果骨干没有 CLS 或其他额外标记,则无需设置此参数。

构建一个 LLaVa-NeXT-视频处理器,它将 LLaVa-NeXT 图像处理器、LLaVa-NeXT-视频处理器和 LLaMa 分词器封装在一个处理器中。

LlavaNextVideoProcessor 提供了 LlavaNextImageProcessorLlavaNextVideoImageProcessorLlamaTokenizerFast 的所有功能。有关更多信息,请参阅 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发到 LlamaTokenizerFast 的 batch_decode()。有关更多信息,请参阅此方法的文档字符串。

decode

< >

( *args **kwargs )

此方法将其所有参数转发给 LlamaTokenizerFast 的 decode()。有关更多信息,请参阅此方法的文档字符串。

LlavaNextVideoImageProcessor

class transformers.LlavaNextVideoImageProcessor

< >

( 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_convert_rgb: bool = True **kwargs )

参数

  • do_resize (bool, optional, defaults to True) — 是否将图像的(高度、宽度)尺寸调整为指定的 size。可在 preprocess 方法中通过 do_resize 覆盖。
  • size (dict[str, int] optional, defaults to {"shortest_edge" -- 224}): 调整大小后的图像尺寸。图像的最短边将调整为 size["shortest_edge"],最长边将调整为保持输入宽高比。可在 preprocess 方法中通过 size 覆盖。
  • image_grid_pinpoints (List optional, defaults to [[672, 336], [336, 672], [672, 672], [336, 1008], [1008, 336]]) — 用于处理高分辨率图像的可能分辨率列表。将根据图像的原始尺寸选择最佳分辨率。可在 preprocess 方法中通过 image_grid_pinpoints 覆盖。不用于视频处理。
  • resample (PILImageResampling, optional, defaults to Resampling.BICUBIC) — 调整图像大小时使用的重采样滤镜。可在 preprocess 方法中通过 resample 覆盖。
  • do_center_crop (bool, optional, defaults to True) — 是否将图像中心裁剪为指定的 crop_size。可在 preprocess 方法中通过 do_center_crop 覆盖。
  • crop_size (dict[str, int] optional, defaults to 224) — 应用 center_crop 后输出图像的尺寸。可在 preprocess 方法中通过 crop_size 覆盖。
  • do_rescale (bool, optional, defaults to True) — 是否按指定的比例 rescale_factor 重新缩放图像。可在 preprocess 方法中通过 do_rescale 覆盖。
  • rescale_factor (int or float, optional, defaults to 1/255) — 重新缩放图像时使用的比例因子。可在 preprocess 方法中通过 rescale_factor 覆盖。
  • do_normalize (bool, optional, defaults to True) — 是否对图像进行标准化。可在 preprocess 方法中通过 do_normalize 覆盖。
  • image_mean (float or list[float], optional, defaults to [0.48145466, 0.4578275, 0.40821073]) — 标准化图像时使用的均值。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可在 preprocess 方法中通过 image_mean 参数覆盖。
  • image_std (float or list[float], optional, defaults to [0.26862954, 0.26130258, 0.27577711]) — 标准化图像时使用的标准差。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可在 preprocess 方法中通过 image_std 参数覆盖。
  • do_convert_rgb (bool, optional, defaults to True) — 是否将图像转换为 RGB。

构造一个 LLaVa-NeXT-Video 视频处理器。基于 CLIPImageProcessor,并结合了每帧视频的处理。

preprocess

< >

( images: typing.Union[list['PIL.Image.Image'], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), list['np.ndarray'], list['torch.Tensor'], list[list['PIL.Image.Image']], list[list['np.ndarrray']], list[list['torch.Tensor']]] do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = 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_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 (VideoInput) — 要预处理的视频。期望单个或批处理的视频,像素值范围为 0 到 255。如果传入的图像像素值在 0 到 1 之间,请设置 do_rescale=False
  • do_resize (bool, optional, defaults to self.do_resize) — 是否调整视频大小。
  • 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"> size (dict[str, int], optional, defaults to self.size) — 调整大小后的视频尺寸。视频的最短边将调整为 size["shortest_edge"],最长边将调整为保持输入宽高比。
  • resample (int, optional, defaults to self.resample) — 调整视频大小时使用的重采样滤镜。可以是枚举 PILImageResampling 之一。仅当 do_resize 设置为 True 时有效。
  • do_center_crop (bool, optional, defaults to self.do_center_crop) — 是否对视频进行中心裁剪。
  • crop_size (dict[str, int], optional, defaults to self.crop_size) — 中心裁剪的尺寸。仅当 do_center_crop 设置为 True 时有效。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否重新缩放视频。
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 如果 do_rescale 设置为 True,用于重新缩放视频的比例因子。
  • do_normalize (bool, optional, defaults to self.do_normalize) — 是否对视频进行标准化。
  • image_mean (float or list[float], optional, defaults to self.image_mean) — 用于标准化的帧均值。仅当 do_normalize 设置为 True 时有效。
  • image_std (float or list[float], optional, defaults to self.image_std) — 用于标准化的帧标准差。仅当 do_normalize 设置为 True 时有效。
  • do_convert_rgb (bool, optional, defaults to self.do_convert_rgb) — 是否将视频转换为 RGB。
  • return_tensors (str or 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 or str, optional, defaults to ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • 未设置:使用输入图像的通道维度格式。
  • input_data_format (ChannelDimension or str, optional) — 输入图像的通道维度格式。如果未提供,将从输入图像中推断。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。

resize

< >

( image: ndarray size: dict resample: Resampling = <Resampling.BICUBIC: 3> data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None **kwargs )

参数

  • image (np.ndarray) — 要调整大小的图像。
  • size (dict[str, int]) — 输出图像的尺寸。
  • resample (PILImageResampling, optional, defaults to PILImageResampling.BICUBIC) — 调整图像大小时使用的重采样滤镜。
  • data_format (str or ChannelDimension, optional) — 图像的通道维度格式。如果未提供,将与输入图像的格式相同。
  • input_data_format (ChannelDimension or str, optional) — 输入图像的通道维度格式。如果未提供,将自动推断。

调整图像大小。图像的最短边将调整为 size["shortest_edge"],最长边将调整为保持输入宽高比。

LlavaNextVideoVideoProcessor

class transformers.LlavaNextVideoVideoProcessor

< >

( **kwargs: typing_extensions.Unpack[transformers.models.llava_next_video.video_processing_llava_next_video.LlavaNextVideoFastVideoProcessorInitKwargs] )

LlavaNextVideoModel

class transformers.LlavaNextVideoModel

< >

( config: LlavaNextVideoConfig )

参数

  • config (LlavaNextVideoConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。

Llava-Next 模型由一个视觉骨干和一个没有语言建模头的语言模型组成。

此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档以了解所有与一般用法和行为相关的事项。

forward

< >

( input_ids: LongTensor = None pixel_values: FloatTensor = None pixel_values_videos: 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 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 **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoModelOutputWithPast or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列词汇表中令牌的索引。默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参见 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • pixel_values_videos (torch.FloatTensor of shape (batch_size, num_frames, num_channels, image_size, image_size)) -- 对应于输入视频的张量。像素值可以使用 [AutoImageProcessor](/docs/transformers/v4.53.3/en/model_doc/auto#transformers.AutoImageProcessor) 获取。有关详细信息,请参见 LlavaNextVideoVideoProcessor.call()`。 LlavaProcessor 使用 LlavaNextVideoVideoProcessor 处理视频。
  • image_sizes (torch.LongTensor of shape (batch_size, 2), optional) — 批次中图像的尺寸,每个图像为(高度,宽度)。
  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充令牌索引执行注意力的掩码。掩码值选择范围为 [0, 1]

    • 1 表示 未被掩码 的令牌,
    • 0 表示 被掩码 的令牌。

    什么是注意力掩码?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • past_key_values (list[torch.FloatTensor], 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。通常由模型在解码的先前阶段返回,当 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,用户可以选择只输入形状为 (batch_size, 1) 的最后一个 input_ids(那些没有将其过去的键值状态提供给此模型的),而不是所有形状为 (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 相反,此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。

返回

transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoModelOutputWithPasttuple(torch.FloatTensor)

一个 transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),根据配置(LlavaNextVideoConfig)和输入包含各种元素。

  • 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。

  • video_hidden_states (torch.FloatTensor, 可选) — 一个大小为 (batch_size * num_frames, num_videos, sequence_length, hidden_size)torch.FloatTensor。由视觉编码器生成并投影最后一个隐藏状态后的 video_hidden_states。

LlavaNextVideoModel 的前向方法,重写了 __call__ 特殊方法。

尽管前向传播的实现需要在该函数中定义,但此后应调用 Module 实例,因为前者负责运行预处理和后处理步骤,而后者则默默忽略它们。

get_image_features

< >

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

参数

  • pixel_values (torch.FloatTensor],形状为 (batch_size, num_patches, channels, height, width)) — 对应于输入图像的张量。
  • image_sizes (torch.Tensor,形状为 (num_images, 2)) — 每张图像的实际尺寸 (高, 宽)。
  • vision_feature_layer (Union[int, list[int]], 可选) — 选择视觉特征的层索引。如果提供多个索引,则相应索引的视觉特征将被连接起来形成视觉特征。
  • vision_feature_select_strategy (str, 可选) — 用于从视觉骨干中选择视觉特征的特征选择策略。可以是 "default""full"

返回

image_features (listtorch.Tensor)

图像特征张量列表,每个张量包含所有补丁的所有视觉特征,形状为 (num_patches, image_length, embed_dim)

从视觉塔获取图像最后隐藏状态并应用多模态投影。

get_video_features

< >

( pixel_values: FloatTensor vision_feature_layer: typing.Union[int, list[int], NoneType] = None vision_feature_select_strategy: typing.Optional[str] = None ) video_features (listtorch.Tensor)

参数

  • pixel_values (torch.FloatTensor],形状为 (batch_size, num_frames, channels, height, width)) — 对应于输入视频的张量。像素值可以使用 [AutoImageProcessor](/docs/transformers/v4.53.3/en/model_doc/auto#transformers.AutoImageProcessor) 获取。有关详细信息,请参阅 LlavaNextVideoVideoProcessor.__call__()LlavaProcessor 使用 LlavaNextVideoVideoProcessor 来处理视频。
  • vision_feature_layer (Union[int, list[int]], 可选) — 选择视觉特征的层索引。如果提供多个索引,则相应索引的视觉特征将被连接起来形成视觉特征。
  • vision_feature_select_strategy (str, 可选) — 用于从视觉骨干中选择视觉特征的特征选择策略。可以是 "default""full"

返回

video_features (listtorch.Tensor)

视频特征张量列表,每个张量包含所有补丁的所有视觉特征,形状为 (num_videos, video_length, embed_dim))。

从视觉塔获取视频最后一个隐藏状态,并应用多模态投影。

pack_image_features

< >

( image_features image_sizes vision_feature_select_strategy image_newline = None )

参数

  • image_features (list[torch.Tensor],长度为 num_images,每个形状为 (num_patches, image_length, embed_dim)) — 图像特征张量列表,每个张量包含所有补丁的所有视觉特征。
  • image_sizes (torch.Tensor,形状为 (num_images, 2)) — 每张图像的实际尺寸 (高, 宽)。
  • vision_feature_select_strategy (str) — 用于从视觉骨干中选择视觉特征的特征选择策略。
  • image_newline (torch.Tensor,形状为 (embed_dim)) — 新行嵌入向量。

重塑、取消填充,然后将每个 image_feature 打包成一个包含所有视觉向量的单个 image_features 张量。

LlavaNextVideoForConditionalGeneration

class transformers.LlavaNextVideoForConditionalGeneration

< >

( config: LlavaNextVideoConfig )

参数

  • config (LlavaNextVideoConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重,只加载配置。请查阅 from_pretrained() 方法以加载模型权重。

LLAVA-NeXT 模型由一个视觉骨干和一个语言模型组成。

此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档以了解所有与一般用法和行为相关的事项。

forward

< >

( input_ids: LongTensor = None pixel_values: FloatTensor = None pixel_values_videos: 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 return_dict: 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_video.modeling_llava_next_video.KwargsForCausalLM] ) transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoCausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列令牌的索引。填充将默认忽略。

    索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 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} 处理图像)。
  • pixel_values_videos (torch.FloatTensor,形状为 (batch_size, num_frames, num_channels, image_size, image_size)) — 对应于输入视频的张量。像素值可以使用 [AutoImageProcessor](/docs/transformers/v4.53.3/en/model_doc/auto#transformers.AutoImageProcessor) 获取。有关详细信息,请参阅 LlavaNextVideoVideoProcessor.__call__()LlavaProcessor 使用 LlavaNextVideoVideoProcessor 来处理视频。
  • image_sizes (torch.LongTensor,形状为 (batch_size, 2)可选) — 批次中图像的大小,每张图像为 (高, 宽)。
  • 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]

    什么是位置 ID?

  • past_key_values (list[torch.FloatTensor], 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。通常由模型在解码的先前阶段返回,当 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,用户可以选择只输入形状为 (batch_size, 1) 的最后一个 input_ids(那些没有将其过去的键值状态提供给此模型的),而不是所有形状为 (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,则必须是 1D,对应于序列长度维度中要保留的索引。这在使用打包张量格式(批次和序列长度的单个维度)时非常有用。

返回

transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoCausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.models.llava_next_video.modeling_llava_next_video.LlavaNextVideoCausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),根据配置(LlavaNextVideoConfig)和输入包含各种元素。

  • 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_patches, num_images, sequence_length, hidden_size)` 的 torch.FloatTensor。由视觉编码器生成并投影最后一个隐藏状态后的 image_hidden_states。

  • video_hidden_states (torch.FloatTensor, 可选) — 一个大小为 (batch_size * num_frames, num_videos, sequence_length, hidden_size)torch.FloatTensor。由视觉编码器生成并投影最后一个隐藏状态后的 video_hidden_states。

LlavaNextVideoForConditionalGeneration 的前向方法,重写了 __call__ 特殊方法。

尽管前向传播的实现需要在该函数中定义,但此后应调用 Module 实例,因为前者负责运行预处理和后处理步骤,而后者则默默忽略它们。

示例

>>> from PIL import Image
>>> import requests
>>> import av
>>> from transformers import AutoProcessor, LlavaNextVideoForConditionalGeneration

>>> def read_video_pyav(container, indices):
...     '''
...     Decode the video with PyAV decoder.
...     Args:
...         container (`av.container.input.InputContainer`): PyAV container.
...         indices (`list[int]`): List of frame indices to decode.
...     Returns:
...         result (np.ndarray): np array of decoded frames of shape (num_frames, height, width, 3).
...     '''
...     frames = []
...     container.seek(0)
...     start_index = indices[0]
...     end_index = indices[-1]
...     for i, frame in enumerate(container.decode(video=0)):
...         if i > end_index:
...             break
...         if i >= start_index and i in indices:
...             frames.append(frame)
...     return np.stack([x.to_ndarray(format="rgb24") for x in frames])

>>> model = LlavaNextVideoForConditionalGeneration.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf", device_map="auto")
>>> processor = AutoProcessor.from_pretrained("llava-hf/LLaVA-NeXT-Video-7B-hf")

>>> prompt = "USER: <video>\nWhy is this video funny? ASSISTANT:"
>>> video_path = hf_hub_download(repo_id="raushan-testing-hf/videos-test", filename="sample_demo_1.mp4", repo_type="dataset")
>>> container = av.open(video_path)

>>> # sample uniformly 8 frames from the video (model was trained with 32 frames per video, but this video is short)
>>> total_frames = container.streams.video[0].frames
>>> indices = np.arange(0, total_frames, total_frames / 8).astype(int)
>>> clip = read_video_pyav(container, indices)
>>> inputs_video = processor(text=prompt, videos=clip, return_tensors="pt").to(model.device)

>>> # load an image to generate from an image
>>> prompt = "USER:<image>\nWhat is shown in this image? ASSISTANT:"
>>> url = "https://www.ilankelman.org/stopsigns/australia.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> inputs_image = processor(text=prompt, images=image, return_tensors="pt").to(model.device)

>>> # Generate from video
>>> generate_ids = model.generate(**inputs_video, max_length=50)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"USER:\nWhy is this video funny? ASSISTANT: The humor in this video comes from the unexpected and endearing sight of a baby wearing glasses and (...)"

>>> # Generate from image
>>> generate_ids = model.generate(**inputs_image, max_length=30)
>>> 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 shows a red stop sign on a pole, with a traditional Chinese archway (...)"
< > 在 GitHub 上更新