Transformers 文档

InstructBlipVideo

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

InstructBlipVideo

PyTorch

概述

InstructBLIPVideo 是 InstructBLIP:通过指令调优实现通用视觉-语言模型 中 Wenliang Dai、Junnan Li、Dongxu Li、Anthony Meng Huat Tiong、Junqi Zhao、Weisheng Wang、Boyang Li、Pascale Fung、Steven Hoi 提出的模型的扩展。InstructBLIPVideo 使用与 InstructBLIP 相同的架构,并与 InstructBLIP 使用相同的检查点。唯一的区别是能够处理视频。

论文摘要如下:

通用语言模型通过预训练和指令调优流程,已能够解决各种语言领域的任务。然而,由于引入了额外的视觉输入,增加了任务差异,构建通用视觉-语言模型具有挑战性。尽管视觉-语言预训练已被广泛研究,但视觉-语言指令调优的探索相对较少。在本文中,我们基于预训练的 BLIP-2 模型对视觉-语言指令调优进行了系统而全面的研究。我们收集了 26 个公开可用的多样化数据集,将其转换为指令调优格式,并将其分为两个集群:用于持有指令调优和持有零样本评估。此外,我们引入了指令感知视觉特征提取,这是一种关键方法,使模型能够提取针对给定指令定制的信息特征。由此产生的 InstructBLIP 模型在所有 13 个持有数据集上均取得了最先进的零样本性能,显著优于 BLIP-2 和更大的 Flamingo。我们的模型在针对单个下游任务进行微调时也取得了最先进的性能(例如,在 ScienceQA IMG 上达到 90.7% 的准确率)。此外,我们定性地展示了 InstructBLIP 相对于同期多模态模型的优势。

drawing InstructBLIPVideo 架构。取自 原始论文。

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

使用提示

  • 该模型通过每视频采样 4 帧进行训练,因此建议采样 4 帧。

[!NOTE] BLIP 模型在 v4.46 版本发布后,会发出关于添加 processor.num_query_tokens = {{num_query_tokens}} 并扩展模型嵌入层以添加特殊 <image> 标记的警告。如果您拥有模型检查点,强烈建议您将这些属性添加到处理器中;如果不是您拥有的,则打开 PR。添加这些属性意味着 BLIP 将添加每个图像所需的查询标记数量,并用与查询标记数量相同的 <image> 占位符扩展文本。通常每个图像大约有 500 个标记,因此请确保文本没有被截断,否则在合并嵌入时会出现故障。这些属性可以从模型配置中获取,作为 model.config.num_query_tokens,模型嵌入扩展可以按照 此链接 进行。

InstructBlipVideoConfig

class transformers.InstructBlipVideoConfig

< >

( vision_config = None qformer_config = None text_config = None num_query_tokens = 32 video_token_index = None **kwargs )

参数

  • vision_config (dict, 可选) — 用于初始化 InstructBlipVideoVisionConfig 的配置选项字典。
  • qformer_config (dict, 可选) — 用于初始化 InstructBlipVideoQFormerConfig 的配置选项字典。
  • text_config (dict, 可选) — 用于初始化任意 PretrainedConfig 的配置选项字典。
  • num_query_tokens (int, 可选, 默认为 32) — 通过 Transformer 的查询标记数量。
  • video_token_index (int, 可选) — 特殊视频标记的标记索引。
  • kwargs (可选) — 关键字参数字典。

InstructBlipVideoConfig 是用于存储 InstructBlipVideoForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 Instructblipvideo 模型,定义视觉模型、Q-Former 模型和语言模型配置。使用默认值实例化配置将生成与 Instructblipvideo Salesforce/instruct-blip-flan-t5 架构相似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请参阅 PretrainedConfig 的文档。

示例

>>> from transformers import (
...     InstructBlipVideoVisionConfig,
...     InstructBlipVideoQFormerConfig,
...     OPTConfig,
...     InstructBlipVideoConfig,
...     InstructBlipVideoForConditionalGeneration,
... )

>>> # Initializing a InstructBlipVideoConfig with Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoConfig()

>>> # Initializing a InstructBlipVideoForConditionalGeneration (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoForConditionalGeneration(configuration)

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

>>> # We can also initialize a InstructBlipVideoConfig from a InstructBlipVideoVisionConfig, InstructBlipVideoQFormerConfig and any PretrainedConfig

>>> # Initializing Instructblipvideo vision, Instructblipvideo Q-Former and language model configurations
>>> vision_config = InstructBlipVideoVisionConfig()
>>> qformer_config = InstructBlipVideoQFormerConfig()
>>> text_config = OPTConfig()

>>> config = InstructBlipVideoConfig.from_text_vision_configs(vision_config, qformer_config, text_config)

from_vision_qformer_text_configs

< >

( vision_config: InstructBlipVideoVisionConfig qformer_config: InstructBlipVideoQFormerConfig text_config: PretrainedConfig **kwargs ) InstructBlipVideoConfig

返回

InstructBlipVideoConfig

一个配置对象的实例

从 InstructBlipVideo 视觉模型、Q-Former 和语言模型配置实例化 InstructBlipVideoConfig(或派生类)。

InstructBlipVideoVisionConfig

class transformers.InstructBlipVideoVisionConfig

< >

( hidden_size = 1408 intermediate_size = 6144 num_hidden_layers = 39 num_attention_heads = 16 image_size = 224 patch_size = 14 hidden_act = 'gelu' layer_norm_eps = 1e-06 attention_dropout = 0.0 initializer_range = 1e-10 qkv_bias = True **kwargs )

参数

  • hidden_size (int, 可选, 默认为 1408) — 编码器层和池化层的维度。
  • intermediate_size (int, 可选, 默认为 6144) — Transformer 编码器中“中间”(即前馈)层的维度。
  • num_hidden_layers (int, 可选, 默认为 39) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数量。
  • image_size (int, 可选, 默认为 224) — 每张图像的大小(分辨率)。
  • patch_size (int, 可选, 默认为 14) — 每个补丁的大小(分辨率)。
  • hidden_act (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,则支持 "gelu""relu""selu""gelu_new" "gelu"。到 1e-5):层归一化层使用的 epsilon。
  • layer_norm_eps (float, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
  • initializer_range (float, 可选, 默认为 1e-10) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • qkv_bias (bool, 可选, 默认为 True) — 是否在自注意力层中为查询和值添加偏置。

这是用于存储 InstructBlipVideoVisionModel 配置的配置类。它用于根据指定的参数实例化 InstructBlipVideo 视觉编码器,定义模型架构。实例化默认配置将生成与 InstructBlipVideo Salesforce/instruct-blip-flan-t5 架构相似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请参阅 PretrainedConfig 的文档。

示例

>>> from transformers import InstructBlipVideoVisionConfig, InstructBlipVideoVisionModel

>>> # Initializing a InstructBlipVideoVisionConfig with Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoVisionConfig()

>>> # Initializing a InstructBlipVideoVisionModel (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoVisionModel(configuration)

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

InstructBlipVideoQFormerConfig

class transformers.InstructBlipVideoQFormerConfig

< >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' cross_attention_frequency = 2 encoder_hidden_size = 1408 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — Q-Former 模型的词汇量。定义了调用模型时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”(通常称为前馈)层的维度。
  • hidden_act (strCallable, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,则支持 "gelu""relu""silu""gelu_new"
  • hidden_dropout_prob (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。
  • max_position_embeddings (int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常为了以防万一会将其设置为较大的值(例如 512 或 1024 或 2048)。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
  • pad_token_id (int, 可选, 默认为 0) — 用于填充序列的 token id。
  • position_embedding_type (str, 可选, 默认为 "absolute") — 位置嵌入类型。选择 "absolute", "relative_key", "relative_key_query" 之一。对于位置嵌入,请使用 "absolute"。有关 "relative_key" 的更多信息,请参阅《带有相对位置表示的自注意力 (Shaw et al.)》。有关 "relative_key_query" 的更多信息,请参阅《通过更好的相对位置嵌入改进 Transformer 模型 (Huang et al.)》中的方法 4
  • cross_attention_frequency (int, 可选, 默认为 2) — 将交叉注意力添加到 Transformer 层中的频率。
  • encoder_hidden_size (int, 可选, 默认为 1408) — 用于交叉注意力的隐藏状态的隐藏大小。

这是用于存储 InstructBlipVideoQFormerModel 配置的配置类。它用于根据指定参数实例化 InstructBlipVideo 查询 Transformer (Q-Former) 模型,定义模型架构。使用默认值实例化配置将生成与 InstructBlipVideo Salesforce/instruct-blip-flan-t5 架构类似的配置。配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。

请注意,InstructBlipVideoQFormerModel 与带有交错交叉注意力的 BertLMHeadModel 非常相似。

示例

>>> from transformers import InstructBlipVideoQFormerConfig, InstructBlipVideoQFormerModel

>>> # Initializing a InstructBlipVideo Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoQFormerConfig()

>>> # Initializing a model (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoQFormerModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

InstructBlipVideoProcessor

class transformers.InstructBlipVideoProcessor

<

( video_processor tokenizer qformer_tokenizer num_query_tokens = None **kwargs )

参数

  • video_processor (InstructBlipVideoVideoProcessor) — InstructBlipVideoVideoProcessor 的实例。视频处理器是一个必需的输入。
  • tokenizer (AutoTokenizer) — [‘PreTrainedTokenizer`] 的实例。分词器是必需的输入。
  • qformer_tokenizer (AutoTokenizer) — [‘PreTrainedTokenizer`] 的实例。Q-Former 分词器是必需的输入。
  • num_query_tokens (int, 可选) — Qformer 用作查询的 token 数量,应与模型的配置相同。

构造一个 InstructBLIPVideo 处理器,它将 InstructBLIP 图像处理器和 LLaMa/T5 分词器封装成一个单一的处理器。

InstructBlipVideoProcessor 提供了 InstructBlipVideoImageProcessorAutoTokenizer 的所有功能。有关更多信息,请参阅 __call__()decode() 的文档字符串。

batch_decode

<

( *args **kwargs )

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

decode

<

( *args **kwargs )

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

InstructBlipVideoVideoProcessor

class transformers.InstructBlipVideoVideoProcessor

<

( **kwargs: typing_extensions.Unpack[transformers.models.instructblipvideo.video_processing_instructblipvideo.InstructBlipVideoVideoProcessorInitKwargs] )

preprocess

<

( videos: 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']]] **kwargs: typing_extensions.Unpack[transformers.processing_utils.VideosKwargs] )

参数

  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否将视频的 (高度, 宽度) 尺寸调整到指定的 size。可以通过 preprocess 方法中的 do_resize 参数覆盖。
  • size (dict, 可选, 默认为 self.size) — 调整大小后的输出视频大小。可以通过 preprocess 方法中的 size 参数覆盖。
  • size_divisor (int, 可选, 默认为 self.size_divisor) — 确保高度和宽度都能被其整除的大小。
  • default_to_square (bool, 可选, 默认为 self.default_to_square) — 如果 size 是一个整数,是否默认调整为方形视频。
  • resample (PILImageResampling, 可选, 默认为 self.resample) — 如果调整视频大小,则使用的重采样滤波器。仅当 do_resize 设置为 True 时才生效。可以通过 preprocess 方法中的 resample 参数覆盖。
  • do_center_crop (bool, 可选, 默认为 self.do_center_crop) — 是否将视频中心裁剪到指定的 crop_size。可以通过 preprocess 方法中的 do_center_crop 覆盖。
  • do_pad (bool, 可选) — 是否将视频填充到批次中视频的 (max_height, max_width)
  • crop_size (dict[str, int] 可选, 默认为 self.crop_size) — 应用 center_crop 后的输出视频大小。可以通过 preprocess 方法中的 crop_size 覆盖。
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否按指定的比例 rescale_factor 重新缩放视频。仅当 do_rescale 设置为 True 时才生效。可以通过 preprocess 方法中的 do_rescale 参数覆盖。
  • rescale_factor (intfloat, 可选, 默认为 self.rescale_factor) — 如果重新缩放视频,则使用的比例因子。仅当 do_rescale 设置为 True 时才生效。可以通过 preprocess 方法中的 rescale_factor 参数覆盖。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否规范化视频。可以通过 preprocess 方法中的 do_normalize 参数覆盖。可以通过 preprocess 方法中的 do_normalize 参数覆盖。
  • image_mean (floatlist[float], 可选, 默认为 self.image_mean) — 如果规范化视频,则使用的均值。这是一个浮点数或浮点数列表,其长度与视频中的通道数相同。可以通过 preprocess 方法中的 image_mean 参数覆盖。可以通过 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (floatlist[float], 可选, 默认为 self.image_std) — 如果规范化视频,则使用的标准差。这是一个浮点数或浮点数列表,其长度与视频中的通道数相同。可以通过 preprocess 方法中的 image_std 参数覆盖。可以通过 preprocess 方法中的 image_std 参数覆盖。
  • do_convert_rgb (bool, 可选, 默认为 self.image_std) — 是否将视频转换为 RGB。
  • video_metadata (VideoMetadata, 可选) — 视频的元数据,包含总时长、帧率和总帧数信息。
  • do_sample_frames (int, 可选, 默认为 self.do_sample_frames) — 在处理前是否从视频中采样帧,或处理整个视频。
  • num_frames (int, 可选, 默认为 self.num_frames) — 当 do_sample_frames=True 时,要采样的最大帧数。
  • fps (int, 可选, 默认为 self.fps) — 当 do_sample_frames=True 时,每秒要采样的目标帧数。
  • return_tensors (strTensorType, 可选) — 如果设置为 `pt`,则返回堆叠的张量,否则返回张量列表。
  • data_format (ChannelDimensionstr, 可选, 默认为 ChannelDimension.FIRST) — 输出视频的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:视频格式为 (通道数, 高度, 宽度)。
    • "channels_last"ChannelDimension.LAST:视频格式为 (高度, 宽度, 通道数)。
    • 未设置:使用输入视频的通道维度格式。
  • input_data_format (ChannelDimensionstr, 可选) — 输入视频的通道维度格式。如果未设置,则从输入视频推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:视频格式为 (通道数, 高度, 宽度)。
    • "channels_last"ChannelDimension.LAST:视频格式为 (高度, 宽度, 通道数)。
    • "none"ChannelDimension.NONE:视频格式为 (高度, 宽度)。
  • device (torch.device, 可选) — 处理视频的设备。如果未设置,则从输入视频推断设备。

InstructBlipVideoImageProcessor

class transformers.InstructBlipVideoImageProcessor

<

( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BICUBIC: 3> 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, 可选, 默认为 True) — 是否将图像的 (高度, 宽度) 尺寸调整到指定的 size。可以通过 preprocess 方法中的 do_resize 参数覆盖。
  • size (dict, 可选, 默认为 {"height" -- 384, "width": 384}):调整大小后的输出图像大小。可以通过 preprocess 方法中的 size 参数覆盖。
  • resample (PILImageResampling, 可选, 默认为 Resampling.BICUBIC) — 如果调整图像大小,则使用的重采样滤波器。仅当 do_resize 设置为 True 时才生效。可以通过 preprocess 方法中的 resample 参数覆盖。
  • do_rescale (bool, 可选, 默认为 True) — 是否按指定的比例 rescale_factor 重新缩放图像。仅当 do_rescale 设置为 True 时才生效。可以通过 preprocess 方法中的 do_rescale 参数覆盖。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 如果重新缩放图像,则使用的比例因子。仅当 do_rescale 设置为 True 时才生效。可以通过 preprocess 方法中的 rescale_factor 参数覆盖。
  • do_normalize (bool, 可选, 默认为 True) — 是否规范化图像。可以通过 preprocess 方法中的 do_normalize 参数覆盖。可以通过 preprocess 方法中的 do_normalize 参数覆盖。
  • image_mean (floatlist[float], 可选, 默认为 IMAGENET_STANDARD_MEAN) — 如果规范化图像,则使用的均值。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可以通过 preprocess 方法中的 image_mean 参数覆盖。可以通过 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (floatlist[float], 可选, 默认为 IMAGENET_STANDARD_STD) — 如果规范化图像,则使用的标准差。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可以通过 preprocess 方法中的 image_std 参数覆盖。可以通过 preprocess 方法中的 image_std 参数覆盖。
  • do_convert_rgb (bool, 可选, 默认为 True) — 是否将图像转换为 RGB。

构造一个 InstructBLIPVideo 图像处理器。

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']]] = None do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: Resampling = 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 return_tensors: typing.Union[transformers.utils.generic.TensorType, str, NoneType] = None do_convert_rgb: typing.Optional[bool] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

参数

  • videos (VideoInput) — 待预处理的视频帧。期望单个或批量的视频,作为像素值范围从0到255的帧列表。如果传入像素值在0到1之间的视频,请设置do_rescale=False
  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否调整视频大小。
  • size (dict[str, int], 可选, 默认为 self.size) — 控制resize后视频的大小。图像的最短边将调整为size["shortest_edge"],同时保持纵横比。如果此调整大小后的图像的最长边大于int(size["shortest_edge"] * (1333 / 800)),则图像将再次调整大小,使最长边等于int(size["shortest_edge"] * (1333 / 800))
  • resample (PILImageResampling, 可选, 默认为 self.resample) — 如果调整视频大小,则使用的重采样滤波器。仅当do_resize设置为True时才有效。
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否将视频值缩放到 [0 - 1] 之间。
  • rescale_factor (float, 可选, 默认为 self.rescale_factor) — 如果do_rescale设置为True,则用于缩放视频的缩放因子。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对视频进行归一化。
  • image_mean (floatlist[float], 可选, 默认为 self.image_mean) — 如果do_normalize设置为True,则用于归一化视频的图像平均值。
  • image_std (floatlist[float], 可选, 默认为 self.image_std) — 如果do_normalize设置为True,则用于归一化视频的图像标准差。
  • do_convert_rgb (bool, 可选, 默认为 self.do_convert_rgb) — 是否将图像转换为RGB格式。
  • return_tensors (strTensorType, 可选) — 要返回的张量类型。可以是以下之一:
    • 未设置:返回一个 np.ndarray 列表。
    • TensorType.TENSORFLOW'tf':返回一个 tf.Tensor 类型的批次。
    • TensorType.PYTORCH'pt':返回一个 torch.Tensor 类型的批次。
    • TensorType.NUMPY'np':返回一个 np.ndarray 类型的批次。
    • TensorType.JAX'jax':返回一个 jax.numpy.ndarray 类型的批次。
  • data_format (ChannelDimensionstr, 可选, 默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (通道数, 高度, 宽度)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (高度, 宽度, 通道数)。
    • 未设置:使用输入图像的通道维度格式。
  • input_data_format (ChannelDimensionstr, 可选) — 输入图像的通道维度格式。如果未设置,将从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (通道数, 高度, 宽度)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (高度, 宽度, 通道数)。
    • "none"ChannelDimension.NONE:图像格式为 (高度, 宽度)。

预处理视频或图像/视频批次。

InstructBlipVideoVisionModel

class transformers.InstructBlipVideoVisionModel

< >

( config: InstructBlipVideoVisionConfig )

forward

< >

( pixel_values: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None interpolate_pos_encoding: bool = False ) transformers.modeling_outputs.BaseModelOutputWithPooling or tuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor, 可选) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 进行图像处理)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
  • interpolate_pos_encoding (bool, 默认为 False) — 是否插值预训练的位置编码。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),包含根据配置(InstructBlipVideoConfig)和输入的不同元素。

  • last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • pooler_output (形状为 (batch_size, hidden_size)torch.FloatTensor) — 序列中第一个标记(分类标记)的最后一层隐藏状态,经过用于辅助预训练任务的层进一步处理。例如,对于BERT系列模型,这将在预训练期间通过线性层和 tanh 激活函数处理后返回分类标记。线性层权重在预训练期间通过下一个句子预测(分类)目标进行训练。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传入 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(如果模型有嵌入层,则为嵌入层输出,加上每个层的输出)。

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

InstructBlipVideoVisionModel 的 forward 方法,覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在此函数中定义,但此后应调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则悄悄地忽略它们。

InstructBlipVideoQFormerModel

class transformers.InstructBlipVideoQFormerModel

< >

( config: InstructBlipVideoQFormerConfig )

查询 Transformer (Q-Former),用于 InstructBlipVideo。与 BLIP-2 略有不同,因为它也将指令作为输入。

forward

< >

( input_ids: LongTensor attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None query_embeds: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = 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 )

encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor, 可选):编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。encoder_attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor, 可选):用于避免对编码器输入中的填充标记索引执行注意力的掩码。如果模型配置为解码器,则此掩码在交叉注意力中使用。掩码值选择在 [0, 1] 之间。

  • 1 表示 未被掩盖 的标记,
  • 0 表示**被掩码**的标记。past_key_values (长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组包含 4 个张量,形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head)):包含注意力块的预计算键值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择只输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(那些没有将其过去的键值状态提供给此模型的),而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。use_cache (bool, 可选):如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(请参阅 past_key_values)。

InstructBlipVideoModel

class transformers.InstructBlipVideoModel

< >

( config: InstructBlipVideoConfig )

参数

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

InstructBlipVideo 基本模型,由语言模型、Q-former 和视觉编码器组成。

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

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以获取所有与通用用法和行为相关的事项。

forward

< >

( pixel_values: FloatTensor qformer_input_ids: FloatTensor qformer_attention_mask: typing.Optional[torch.LongTensor] = None input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None interpolate_pos_encoding: bool = False use_cache: typing.Optional[bool] = None **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 进行图像处理)。
  • qformer_input_ids (形状为 (batch_size, sequence_length)torch.LongTensor, 可选) — Q-Former 词汇表中的输入序列 token 索引。可以选择提供输入 token 作为文本提示,Q-Former 模型将对其进行编码。

    索引可以使用 InstructBlipVideoProcessor 获取。有关详细信息,请参阅 InstructBlipVideoProcessor.__call__()

    什么是输入 ID?

  • qformer_attention_mask (形状为 (batch_size, sequence_length)torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示**未被掩码**的 token,
    • 0 表示**被掩码**的 token。

    什么是注意力掩码?

  • input_ids (形状为 (batch_size, sequence_length)torch.LongTensor, 可选) — 语言模型词汇表中的输入序列 token 索引。可以选择提供输入 token 作为文本提示,语言模型可以继续生成。

    索引可以使用 InstructBlipVideoProcessor 获取。有关详细信息,请参阅 InstructBlipVideoProcessor.__call__()

    什么是输入 ID?

  • attention_mask (形状为 (batch_size, sequence_length)torch.LongTensor, 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示**未被掩码**的 token,
    • 0 表示**被掩码**的 token。

    什么是注意力掩码?

  • decoder_input_ids (形状为 (batch_size, target_sequence_length)torch.LongTensor, 可选) — 解码器输入序列 token 在词汇表中的索引。

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

    什么是解码器输入 ID?

  • decoder_attention_mask (形状为 (batch_size, target_sequence_length)torch.BoolTensor, 可选) — 默认行为:生成一个忽略 decoder_input_ids 中填充 token 的张量。默认情况下也会使用因果掩码。

    仅当使用编码器-解码器语言模型(如 T5)时才相关。

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
  • interpolate_pos_encoding (bool, 默认为 False) — 是否插值预训练的位置编码。
  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(请参阅 past_key_values)。

返回

transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutputtuple(torch.FloatTensor)

一个 transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),包含根据配置(InstructBlipVideoConfig)和输入的不同元素。

  • loss (torch.FloatTensor, 可选, 当提供 labels 时返回, 形状为 (1,)torch.FloatTensor) — 语言模型的语言建模损失。
  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言模型的语言建模头部预测分数。
  • vision_outputs (torch.FloatTensor, 可选, 默认为 None) — 视觉编码器的输出。
  • qformer_outputs (tuple[torch.FloatTensor], 可选, 默认为 None) — Q-Former(查询 Transformer)的输出。
  • language_model_outputs (CausalLMOutputWithPastSeq2SeqLMOutput) — 语言模型的输出。

InstructBlipVideoModel 的 forward 方法,覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在此函数中定义,但此后应调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则悄悄地忽略它们。

InstructBlipVideoForConditionalGeneration

class transformers.InstructBlipVideoForConditionalGeneration

< >

( config: InstructBlipVideoConfig )

参数

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

InstructBlipVideo 模型,用于根据图像和可选文本提示生成文本。该模型由视觉编码器、查询 Transformer (Q-Former) 和语言模型组成。

可以选择向模型传递 input_ids 作为文本提示,以便语言模型继续提示。否则,语言模型将从 [BOS] (序列开始) token 开始生成文本。

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

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以获取所有与通用用法和行为相关的事项。

forward

< >

( pixel_values: FloatTensor qformer_input_ids: FloatTensor qformer_attention_mask: typing.Optional[torch.LongTensor] = None input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None labels: typing.Optional[torch.LongTensor] = None return_dict: typing.Optional[bool] = None interpolate_pos_encoding: bool = False use_cache: typing.Optional[bool] = None **kwargs: typing_extensions.Unpack[transformers.models.instructblipvideo.modeling_instructblipvideo.KwargsForCausalLM] ) transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 进行图像处理)。
  • qformer_input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — Q-Former 词汇表中输入序列 token 的索引。可以可选地提供输入 token 作为文本提示,Q-Former 模型将对其进行编码。

    可以使用 InstructBlipVideoProcessor 获取索引。有关详细信息,请参阅 InstructBlipVideoProcessor.__call__()

    什么是输入 ID?

  • qformer_attention_mask (torch.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示未被掩盖的 token,
    • 0 表示被掩盖的 token。

    什么是注意力掩码?

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 语言模型词汇表中输入序列 token 的索引。可以可选地提供输入 token 作为文本提示,语言模型可以继续生成。

    可以使用 InstructBlipVideoProcessor 获取索引。有关详细信息,请参阅 InstructBlipVideoProcessor.__call__()

    什么是输入 ID?

  • attention_mask (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示未被掩盖的 token,
    • 0 表示被掩盖的 token。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor,形状为 (batch_size, target_sequence_length)可选) — 解码器输入序列 token 在词汇表中的索引。

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

    什么是解码器输入 ID?

  • decoder_attention_mask (torch.BoolTensor,形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个在 decoder_input_ids 中忽略填充 token 的张量。默认情况下也将使用因果掩码。

    仅在使用编码器-解码器语言模型(如 T5)时相关。

  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • labels (torch.LongTensor,形状为 (batch_size,)可选) — 用于计算语言模型损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 范围内。所有设置为 -100 的标签都将被忽略(被掩盖),损失仅针对 [0, ..., config.vocab_size] 范围内的标签计算。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • interpolate_pos_encoding (bool,默认为 False) — 是否对预训练的位置编码进行插值。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。

返回

transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutputtuple(torch.FloatTensor)

一个 transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput 或一个 torch.FloatTensor 元组(如果传入 return_dict=False 或当 config.return_dict=False 时),包含根据配置(InstructBlipVideoConfig)和输入的不同元素。

  • loss (torch.FloatTensor, 可选, 当提供 labels 时返回, 形状为 (1,)torch.FloatTensor) — 语言模型的语言建模损失。
  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言模型的语言建模头部预测分数。
  • vision_outputs (torch.FloatTensor, 可选, 默认为 None) — 视觉编码器的输出。
  • qformer_outputs (tuple[torch.FloatTensor], 可选, 默认为 None) — Q-Former(查询 Transformer)的输出。
  • language_model_outputs (CausalLMOutputWithPastSeq2SeqLMOutput) — 语言模型的输出。

InstructBlipVideoForConditionalGeneration 的 forward 方法,会覆盖 __call__ 特殊方法。

尽管 forward pass 的配方需要在此函数中定义,但此后应调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则悄悄地忽略它们。

示例

>>> from transformers import InstructBlipVideoProcessor, InstructBlipVideoForConditionalGeneration
>>> import torch
>>> from huggingface_hub import hf_hub_download
>>> import av
>>> import numpy as np

>>> 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 = InstructBlipVideoForConditionalGeneration.from_pretrained("Salesforce/instructblip-vicuna-7b", device_map="auto")
>>> processor = InstructBlipVideoProcessor.from_pretrained("Salesforce/instructblip-vicuna-7b")

>>> file_path = hf_hub_download(
...       repo_id="nielsr/video-demo", filename="eating_spaghetti.mp4", repo_type="dataset"
... )
>>> container = av.open(file_path)

>>> # sample uniformly 4 frames from the videWhy is this video funny?o
>>> total_frames = container.streams.video[0].frames
>>> indices = np.arange(0, total_frames, total_frames / 4).astype(int)
>>> clip = read_video_pyav(container, indices)

>>> prompt = "What is happening in the video?"
>>> inputs = processor(text=prompt, images=clip, return_tensors="pt").to(model.device)

>>> outputs = model.generate(
...     **inputs,
...     do_sample=False,
...     num_beams=5,
...     max_length=256,
...     repetition_penalty=1.5,
...     length_penalty=1.0,
... )
>>> generated_text = processor.batch_decode(outputs, skip_special_tokens=True)[0].strip()
>>> print(generated_text)
"A person is eating a bowl of pasta, and they are using a fork to eat it. The person is sitting at a table, and the plate of pasta is on the table in front"

生成

< >

( pixel_values: FloatTensor qformer_input_ids: typing.Optional[torch.LongTensor] = None qformer_attention_mask: typing.Optional[torch.LongTensor] = None input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None interpolate_pos_encoding: bool = False **generate_kwargs ) captions (列表)

参数

  • pixel_values (torch.FloatTensor,形状为 (batch_size, num_channels, height, width) 或 (batch_size, num_frames, num_channels, height, width)):要处理的输入图像或视频。
  • qformer_input_ids (torch.LongTensor,形状为 (batch_size, sequence_length),可选) — 用作 Q-Former 模块提示的序列。
  • qformer_attention_mask (torch.LongTensor,形状为 (batch_size, sequence_length),可选) — 用于避免在填充 token 索引上执行注意力操作的掩码。
  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length),可选) — 用作生成提示的序列。
  • attention_mask (torch.LongTensor,形状为 (batch_size, sequence_length),可选) — 用于避免在填充 token 索引上执行注意力操作的掩码。
  • interpolate_pos_encoding (bool可选,默认为 False) — 是否对图像嵌入的位置编码进行插值。

返回

captions (列表)

一个字符串列表,长度为 batch_size * num_captions。

覆盖 generate 函数,以便能够将模型用作条件生成器。

< > 在 GitHub 上更新