Transformers文档

TVLT

Hugging Face's logo
加入Hugging Face社区

并获取增强文档体验权限

开始使用

TVLT

此模型仅处于维护模式,我们不接受任何更改其代码的新PR。如果您在运行此模型时遇到任何问题,请重新安装支持此模型的最后版本:v4.40.2。您可以通过运行以下命令来完成此操作:pip install -U transformers==4.40.2

概览

TVLT模型由Zineng Tang、Jaemin Cho、Yixin Nie和Mohit Bansal(前三位作者贡献相同)在《TVLT: Textless Vision-Language Transformer》一文中提出[链接](https://arxiv.org/abs/2209.14156)。Textless Vision-Language Transformer(TVLT)是一种模型,它使用原始的视觉和音频输入进行视觉和语言表示学习,而不使用如分词或自动语音识别(ASR)等特定于文本的模块。它可以执行各种音频视觉和视觉语言任务,如检索、问答等。

论文摘要如下

在这项工作中,我们提出了Textless Vision-Language Transformer(TVLT),其中同质Transformer模块使用原始视觉和音频输入进行视觉和语言表示学习,设计简单,不需要使用如分词或自动语音识别(ASR)等特定于文本的模块。TVLT通过重建连续视频帧和音频频谱的掩码片段(掩码自动编码)和对比建模来对齐视频和音频进行训练。在多种多模态任务上,如视觉问答、图像检索、视频检索和多模态情感分析上,TVLT的表现与其文本基础类似,在推理速度上提高了28倍,而参数量减少了1/3。我们的研究表明,可能从底层视觉和音频信号中学习紧凑高效的视觉语言表示,无需假定文本先验存在。

drawing

TVLT架构。源自原始论文[链接](https://arxiv.org/abs/2102.03334)。

原始代码可在[这里](https://github.com/zinengtang/TVLT)找到。此模型由Zineng Tang提供。

使用技巧

  • TVLT是一个接受pixel_valuesaudio_values作为输入的模型。可以使用TvltProcessor来为模型准备数据。此处理器将图像处理器(用于图像/视频模态)和音频特征提取器(用于音频模态)包装成一个。
  • TVLT使用不同大小图像/视频和音频进行训练:作者将输入图像/视频调整为224像素并限制音频频谱长度为2048。为了使视频和音频批处理成为可能,作者使用了指示哪些像素是真实/填充的pixel_mask和指示哪些音频值是真实/填充的audio_mask
  • TVLT的设计与标准的Vision Transformer(ViT)和masked autoencoder(MAE)类似,如ViTMAE中所示。区别在于模型包括了音频模态的嵌入层。
  • 此模型的PyTorch版本仅在torch 1.10及以上版本中提供。

TvltConfig

transformers.TvltConfig

< >

( image_size = 224 spectrogram_length = 2048 frequency_length = 128 image_patch_size = [16, 16] audio_patch_size = [16, 16] num_image_channels = 3 num_audio_channels = 1 num_frames = 8 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 initializer_range = 0.02 layer_norm_eps = 1e-06 qkv_bias = True use_mean_pooling = False decoder_num_attention_heads = 16 decoder_hidden_size = 512 decoder_num_hidden_layers = 8 decoder_intermediate_size = 2048 pixel_mask_ratio = 0.75 audio_mask_ratio = 0.15 audio_mask_type = 'frame-level' task_matching = True task_mae = True loss_type = 'classification' **kwargs )

参数

  • image_size (int, 可选, 默认为224) — 每张图像的大小(分辨率)。
  • spectrogram_length (int, 可选, 默认为2048) — 每个音频频谱图的时间长度。
  • frequency_lengthint可选,默认为128)—— 声音频谱的频率长度。
  • image_patch_sizeList[int]可选,默认为[16, 16])—— 每个图像块的大小(分辨率)。
  • audio_patch_sizeList[int]可选,默认为[16, 16])—— 每个音频块的大小(分辨率)。
  • num_image_channelsint可选,默认为3)—— 输入图像通道数。
  • num_audio_channels (int, 可选, 默认为1) — 输入音频通道的数量。
  • num_frames (int, 可选, 默认为8) — 输入视频的最大帧数。
  • hidden_size (int, 可选, 默认为768) — 编码器和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为12) — Transformer编码器中的隐藏层数量。
  • num_attention_headsint,可选,默认为12) — Transformer编码器中每个注意力层的注意力头数。
  • intermediate_sizeint,可选,默认为3072) — Transformer编码器“中间”层(即前馈层)的维度。
  • hidden_actstrfunction,可选,默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, 可选, 默认为 0.0) — 所有嵌入层、编码器和池化器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.0) — 注意力概率的dropout比率。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的truncated_normal_initializer的标准方差。
  • layer_norm_eps (float, 可选, 默认为 1e-06) — 层归一化层使用的epsilon。
  • qkv_bias (bool, 可选, 默认为 True) — 是否为查询、键和值添加偏差。
  • use_mean_pooling (bool, 可选, 默认为 False) — 是否使用平均池化最后的隐藏状态,而不是使用 [CLS] 标记的最终隐藏状态。
  • decoder_num_attention_heads (int, 可选, 默认为 16) — 解码器中每个注意力层的注意力头数。
  • decoder_hidden_size (int, 可选, 默认为 512) — 解码器的维度。
  • decoder_num_hidden_layers (int, 可选, 默认为8) —— 解码器中的隐藏层数量。
  • decoder_intermediate_size (int, 可选, 默认为2048) —— 解码器中“中间”层(即前馈层)的维度。
  • pixel_mask_ratio (float, 可选, 默认为0.75) —— 图像补丁掩码比例。
  • audio_mask_ratio (float, 可选, 默认为0.15) —— 声音补丁掩码比例。
  • audio_mask_type (str, 可选, 默认值:"frame-level") — 音频补丁掩码类型,可选择“frame-level”和“patch-level”。
  • task_matching (bool, 可选, 默认值:True) — 是否在预训练中使用视觉音频匹配任务。
  • task_mae (bool, 可选, 默认值:True) — 是否在预训练中使用掩码自动编码器(MAE)。
  • loss_type (str, 可选, 默认值:"classification") — 损失类型包括回归和分类。

这是一个用于存储TvltModel配置的配置类。TvltModel。它用于根据指定的参数实例化一个TVLT模型,定义模型架构。使用默认值实例化配置将得到类似于TVLT ZinengTang/tvlt-base架构的配置。

配置对象继承自PretrainedConfig,可以用来控制模型输出。更多详细信息请参阅PretrainedConfig文档。

示例

>>> from transformers import TvltConfig, TvltModel

>>> # # Initializing a TVLT ZinengTang/tvlt-base style configuration
>>> configuration = TvltConfig()

>>> # # Initializing a model (with random weights) from the ZinengTang/tvlt-base style configuration
>>> model = TvltModel(configuration)

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

TvltProcessor

class transformers.TvltProcessor

< >

( image_processor feature_extractor )

参数

  • image_processor (TvltImageProcessor) — TvltImageProcessor 的一个实例。图像处理器是必需的输入。
  • feature_extractor (TvltFeatureExtractor) — TvltFeatureExtractor 的一个实例。特征提取器是必需的输入。

构建一个 TVLT 处理器,该处理器将 TVLT 图像处理器和 TVLT 特征提取器包装成单个处理器。

TvltProcessor 提供了 TvltImageProcessorTvltFeatureExtractor 的所有功能。有关更多信息,请参阅 call() 的文档字符串。

__call__

< >

( images = None audio = None images_mixed = None sampling_rate = None mask_audio = False mask_pixel = False *args **kwargs )

images 参数传递给 TvltImageProcessor 的 preprocess() 函数,并将 audio 参数传递给 TvltFeatureExtractor 的 call() 函数。有关更多信息,请参考上述两个方法的 docstring。

TvltImageProcessor

transformers.TvltImageProcessor

< >

do_resize: bool = True size: Dict = None patch_size: List = [16, 16] num_frames: int = 8 resample: Resampling = <Resampling.BILINEAR: 2> do_center_crop: bool = True crop_size: Dict = None do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = [0.5, 0.5, 0.5] image_std: Union = [0.5, 0.5, 0.5] init_mask_generator = False **kwargs

参数

  • do_resize (布尔值,可选,默认为True)— 是否将图像的(高度,宽度)尺寸调整到指定的 size。可以通过 preprocess 方法中的 do_resize 参数进行覆盖。
  • size (Dict[str, int] optional, 默认为 {"shortest_edge" -- 224}): 调整后图像的大小。图像最短的一边将被调整到 size["shortest_edge"],同时保持原始图像的宽高比。可以通过 preprocess 方法中的 size 参数进行覆盖。
  • patch_size (List[int] optional, 默认为 [16,16]) — 图像块嵌入的块大小。
  • num_frames (int optional, 默认为 8) — 视频帧的最大数量。
  • resample (PILImageResampling, 可选, 默认 PILImageResampling.BILINEAR) — 若调整图像大小时使用的重采样过滤器。可以通过 preprocess 方法中的 resample 参数进行覆盖。
  • do_center_crop (bool, 可选, 默认为 True) — 是否将图像中心裁剪到指定的 crop_size。可以通过 preprocess 方法中的 do_center_crop 参数进行覆盖。
  • crop_size (Dict[str, int], 可选, 默认值为 {"height" -- 224, "width": 224}):应用中心裁剪后的图像大小。可以通过 preprocess 方法中的 crop_size 参数进行覆盖。
  • do_rescale (bool, 可选,默认为 True) — 是否根据指定的缩放因子 rescale_factor 缩放图像。可以通过 preprocess 方法中的 do_rescale 参数进行覆盖。
  • rescale_factor (intfloat, 可选,默认为 1/255) — 定义缩放图像时要使用的缩放因子。可以通过 preprocess 方法中的 rescale_factor 参数进行覆盖。
  • do_normalize (bool, 可选,默认为 True) — 是否归一化图像。可以通过 preprocess 方法中的 do_normalize 参数进行覆盖。
  • image_mean (floatList[float]可选,默认值为 IMAGENET_STANDARD_MEAN) — 在归一化图像时使用的均值。这是一个浮点数或长度与图像通道数相同的浮点数列表。可以被 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (floatList[float]可选,默认值为 IMAGENET_STANDARD_STD) — 在归一化图像时使用的标准差。这是一个浮点数或长度与图像通道数相同的浮点数列表。可以被 preprocess 方法中的 image_std 参数覆盖。

构建一个 TVLT 图像处理器。

这个处理器可以通过将图像转换为单帧视频来准备模型的视频或图像。

preprocess

< >

( videos: 联合 do_resize: 布尔 = 无 size: 字典 = 无 patch_size: 列表 = 无 num_frames: 整数 = 无 resample: 重采样 = 无 do_center_crop: 布尔 = 无 crop_size: 字典 = 无 do_rescale: 布尔 = 无 rescale_factor: 浮点数 = 无 do_normalize: 布尔 = 无 image_mean: 联合 = 无 image_std: 联合 = 无 is_mixed: 布尔 = 否 return_tensors: 联合 = 无 data_format: 通道维度 = <ChannelDimension.FIRST: 'channels_first'> input_data_format: 联合 = 无 **kwargs ) BatchFeature

参数

  • videos (ImageInput) — 预处理图像或视频。期望单个或一批具有0到255像素值的帧。如果传递具有0到1像素值的帧,则设置 do_rescale=False
  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否调整图片大小。
  • size (Dict[str, int], 可选, 默认为 self.size) — 调整图片大小后的尺寸。
  • patch_size (List[int] 可选, 默认为 self.patch_size) — 图像 patch 嵌入的 patch 大小。
  • num_frames (int 可选, 默认为 self.num_frames) — 最大视频帧数。
  • resample (PILImageResampling, 可选,默认值为 self.resample) — 如果调整图像大小时使用的重采样滤波器。可以是枚举 PILImageResampling 的任何一个值。仅在 do_resize 设置为 True 时才有效。
  • do_center_crop (bool, 可选,默认值为 self.do_centre_crop) — 是否进行居中裁剪图像。
  • crop_size (Dict[str, int], 可选,默认值为 self.crop_size) — 应用居中裁剪后图像的大小。
  • do_rescale (bool, 可选,默认为 self.do_rescale) — 是否重新调整图像值在 [0 - 1] 范围内。
  • rescale_factor (float, 可选,默认为 self.rescale_factor) — 如果设置 do_rescaleTrue,则重新调整图像的调整因子。
  • do_normalize (bool, 可选,默认为 self.do_normalize) — 是否归一化图像。
  • image_mean (floatList[float], 可选,默认为 self.image_mean) — 图像均值。
  • image_std (floatList[float]可选,默认为 self.image_std) — 图像标准差。
  • is_mixed (bool可选) — 输入视频是否有负样本。
  • return_tensorsstrTensorType可选) — 返回张量的类型。可以是以下之一:
    • 未设置:返回 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) — 输出图像的通道维度格式。可以是以下之一:
    • ChannelDimension.FIRST: 图像格式为 (num_channels, height, width)。
    • ChannelDimension.LAST: 图像格式为 (height, width, num_channels)。
    • 未设置:使用输入图像推断的通道维度格式。
  • input_data_format (ChannelDimensionstr,可选) — 输入图像的通道维度格式。如果未设置,将从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST: 图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST: 图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE: 图像格式为 (height, width)。

返回

BatchFeature

包含以下字段的 BatchFeature

  • pixel_values — 传递给模型的像素值,形状为 (batch_size, num_channels, height, width)。

  • pixel_mask — 传递给模型的像素掩码,形状为 (batch_size, num_pixel_patches)。

  • pixel_values_mixed — 传递给模型的像素值,可以是正数或负数,形状为 (batch_size, num_channels, height, width)。

  • pixel_mask_mixed — 传递给模型的像素掩码,可以是正数或负数,形状为 (batch_size, num_pixel_patches)。

预处理视频或图像或视频和图像的批处理。

TvltFeatureExtractor

transformers.TvltFeatureExtractor

< >

( spectrogram_length = 2048 num_channels = 1 patch_size = [16, 16] feature_size = 128 sampling_rate = 44100 hop_length_to_sampling_rate = 86 n_fft = 2048 padding_value = 0.0 **kwargs )

参数

  • spectrogram_length (Dict[str, int] 可选,默认为 2048) — 每个音频频谱的时间长度。
  • num_channels (int 可选,默认为 1) — 音频通道数。
  • patch_size (List[int] 可选,默认为 [16, 16]) — 音频补丁嵌入的大小。
  • feature_size (int可选,默认为 128) — 音频频谱的频率长度。
  • 采样率 (整型, 可选, 默认为44100) — 音频文件数字化的采样率,以赫兹(Hz)表示。
  • hop_length_to_sampling_rate (整型, 可选, 默认为86) — STFT用于获得梅尔频率系数的重叠窗口长度。例如,对于采样率44100,步长为512,则44100 / 512 = 86。
  • n_fft (整型, 可选, 默认为2048) — 傅里叶变换的大小。
  • padding_value (浮点型, 可选, 默认为0.0) — 用作填充音频的填充值。应当对应于静音。

构建一个TVLT音频特征提取器。此特征提取器可用于为模型准备音频。

该特征提取器从FeatureExtractionMixin继承,该类包含了大多数主要方法。用户应参考这个超类来获取关于这些方法更多信息。

__call__

< >

( raw_speech: Union return_tensors: Union = None return_attention_mask: Optional = True sampling_rate: Optional = None resample: bool = False mask_audio: bool = False **kwargs ) BatchFeature

参数

  • raw_speech (np.ndarray, List[float], List[np.ndarray], List[List[float]]) — 要填充的序列或序列批。每个序列可以是numpy数组、浮点数列表、numpy数组列表或浮点数列表的列表。必须是单声道音频,而不是立体声,即每个时间步长只有一个浮点数。
  • return_tensors (strTensorType可选) — 如果设置,将返回张量而不是 Python 整数列表。可接受的值有:

    • 'pt':返回 PyTorch torch.Tensor 对象。
    • 'np':返回 Numpy np.ndarray 对象。
  • return_attention_mask (bool可选,默认为 True) — 是否返回注意力掩码。如果默认,将根据特定特征提取器的默认设置返回注意力掩码。什么是注意力掩码?

    对于 TvltTransformer 模型,attention_mask 应始终传递给批推理,以避免微妙的错误。

  • sampling_rateint可选) — 输入 raw_speech 的采样率。强烈建议在正向调用时传递 sampling_rate,以防止无声错误并允许自动语音识别流程。当前模型支持采样率 16000 和 44100。
  • resample (bool, optional, defaults to False) — If the sampling rate is not matched, resample the input audio to match.
  • mask_audio (bool, optional, defaults to False) — Whether or not to mask input audio for MAE task.

返回

BatchFeature

包含以下字段的 BatchFeature

  • audio_values — To be fed to the model, audio values, shape is (batch_size, num_channels, height, width).

  • audio_mask — To be fed to the model, audio masks, shape is (batch_size, num_audio_patches).

Main method to prepare one or several audio(s) for the model.

TvltModel

class transformers.TvltModel

< >

( config )

参数

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

裸TVLT模型变压器输出原始隐藏状态,顶部不带任何特定头。此模型是PyTorch torch.nn.Module 子类。将其作为常规PyTorch模块使用,并参阅PyTorch文档以了解所有相关于一般使用和行为的资料。

forward

< >

( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: Optional = None audio_mask: Optional = None mask_pixel: bool = False mask_audio: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutput 或者 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_frames, num_channels, height, width)) — 像素值。通过 TvltProcessor 获取像素值。请查看 TvltProcessor.call() 获取详细信息。
  • audio_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 音频值。可以通过 TvltProcessor 获取音频值。请查看 TvltProcessor.call() 获取详细信息。
  • pixel_mask (torch.FloatTensor 的 shape 为 (batch_size, num_pixel_patches)) — 像素掩码。可以通过 TvltProcessor 获取像素掩码。详细信息请参阅 TvltProcessor.call()
  • audio_mask (torch.FloatTensor 的 shape 为 (batch_size, num_audio_patches)) — 声音掩码。可以通过 TvltProcessor 获取声音掩码。详细信息请参阅 TvltProcessor.call()
  • pixel_values_mixed (torch.FloatTensor 的 shape 为 (batch_size, num_frames, num_channels, height, width)) — 在 Tvlt 视听匹配中融合正负样本的像素值。可以通过 TvltProcessor 获取融合的像素值。详细信息请参阅 TvltProcessor.call()
  • pixel_mask_mixedtorch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — pixel_values_mixed 的像素掩码。混合像素掩码可以通过 TvltProcessor 获得。详情请参阅 TvltProcessor.call()
  • mask_pixelbool可选) — 是否对像素进行掩码处理用于 MAE 任务。仅在 TvltForPreTraining 中设置为 True。
  • mask_audiobool可选) — 是否对音频进行掩码处理用于 MAE 任务。仅在 TvltForPreTraining 中设置为 True。
  • output_attentions (bool, 可选) — 否则返回所有注意力层的注意力张量。关于返回张量下的attentions更多详细说明。
  • output_hidden_states (bool, 可选) — 否则返回所有层的隐藏状态。关于返回张量下的hidden_states更多详细说明。
  • return_dict (bool, 可选) — 否则返回ModelOutput而不是普通元组。

返回

transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutputtuple(torch.FloatTensor)

transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutput或一个包含torch.FloatTensor元组(如果传递了return_dict=False,或者当config.return_dict=False时),它根据配置(TvltConfig)和输入包含各种元素。

  • last_hidden_state (torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。
  • last_pixel_hidden_state (torch.getLatitude形状为(batch_size, pixel_sequence_length, hidden_size)) — 模型最后一层的像素序列隐藏状态。
  • last_audio_hidden_state (torch.getLatitude形状为(batch_size, audio_sequence_length, hidden_size)) — 模型最后一层的音频序列隐藏状态。
  • pixel_label_masks (torch.FloatTensor 形状为 (batch_size, pixel_patch_length)) — 指示哪些像素片段被掩码(1)以及未掩码(0)的张量。
  • audio_label_masks (torch.FloatTensor 形状为 (batch_size, audio_patch_length)) — 指示哪些音频片段被掩码(1)以及未掩码(0)的张量。
  • pixel_ids_restore (torch.LongTensor 形状为 (batch_size, pixel_patch_length)) — 包含像素掩码的ids排列的张量。
  • audio_ids_restore (torch.LongTensor 形状为 (batch_size, audio_patch_length)) — 包含音频掩码的ids排列的张量。
  • 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之后的注意力权重,用于在自注意力头中计算加权平均值。

TvltModel 前向方法覆盖了 __call__ 特殊方法。

虽然需要在此函数内定义前向传递的配方,但应该调用 Module 实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import TvltProcessor, TvltModel
>>> import numpy as np
>>> import torch

>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))

>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltModel.from_pretrained("ZinengTang/tvlt-base")

>>> input_dict = processor(images, audio, sampling_rate=44100, return_tensors="pt")

>>> outputs = model(**input_dict)
>>> loss = outputs.loss

TvltModel

transformers.TvltForPreTraining

< >

( config )

参数

  • config (TvltConfig) — 包含了模型所有参数的模型配置类。Using a config file to initialize does not load the weights associated with the model, only the configuration. Please refer to the from_pretrained() method to load the model weights.

Tvlt模型transformer,自监督预训练时解码器在上层。这是一个PyTorch的torch.nn.Module子类。将其视为一个常规的PyTorch Module,有关通用用法和行为的所有问题,请参考PyTorch文档。

forward

( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: Optional = None audio_mask: Optional = None labels: Optional = None pixel_values_mixed: Optional = None pixel_mask_mixed: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_frames, num_channels, height, width)torch.FloatTensor)— 像素值。可以使用 TvltProcessor 获取像素值。有关详细信息,请参阅 TvltProcessor.call()
  • audio_values (形状为 (batch_size, num_channels, height, width)torch.FloatTensor)— 音频值。可以使用 TvltProcessor 获取音频值。有关详细信息,请参阅 TvltProcessor.call()
  • pixel_mask (torch.FloatTensor 形状为 (batch_size, num_pixel_patches)) — 像素掩码。像素掩码可通过 TvltProcessor 获取。有关详细信息,请参阅 TvltProcessor.call()
  • audio_mask (torch.FloatTensor 形状为 (batch_size, num_audio_patches)) — 声音掩码。声音掩码可通过 TvltProcessor 获取。有关详细信息,请参阅 TvltProcessor.call()
  • pixel_values_mixed (torch.FloatTensor 形状为 (batch_size, num_frames, num_channels, height, width)) — 在 Tvlt 视觉音频匹配中混合正样本和负样本的像素值。通过 TvltProcessor 可以获取混合的像素值。有关详细信息,请参阅 TvltProcessor.call()
  • pixel_mask_mixed (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — pixel_values_mixed 的像素掩码。混合像素掩码可以通过使用 TvltProcessor 获取。有关详细信息,请参阅 TvltProcessor.call()
  • mask_pixel (bool可选)- 是否对像素进行掩码以用于 MAE 任务。只有在 TvltForPreTraining 中设置为 True。
  • mask_audio (bool可选)- 是否对音频进行掩码以用于 MAE 任务。只有在 TvltForPreTraining 中设置为 True。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • pixel_values_mixed (torch.FloatTensor 形状 (batch_size, num_frames, num_channels, height, width)) — 在 Tvlt 视觉-音频匹配中混合正负样本的像素值。音频值可以使用 TvltProcessor 获取。有关详细信息,请参阅 TvltProcessor.call()
  • pixel_mask_mixed (torch.FloatTensor 形状 (batch_size, num_channels, height, width)) — pixel_values_mixed 的像素掩码。使用 TvltProcessor 可以获取混合的像素值。有关详细信息,请参阅 TvltProcessor.call()
  • labels (torch.LongTensor 形状 (batch_size, num_labels)可选) — 用于计算视觉音频匹配损失的标签。索引应为 [0, 1]。num_labels 必须为 1。

返回

transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutputtuple(torch.FloatTensor)

transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),它包含各种元素,具体取决于配置(TvltConfig)和输入。

  • loss (torch.FloatTensor 形状 (1,)) — 像素重建损失。
  • matching_logits (torch.FloatTensor 形状 (batch_size, 1)) — 匹配目标的对数。
  • pixel_logits (torch.FloatTensor 形状 (batch_size, pixel_patch_length, image_patch_size ** 3 * pixel_num_channels)):像素重建的对数。
  • audio_logits (torch.FloatTensor 形状 (batch_size, audio_patch_length, image_patch_size[0] * image_patch_size[1])):音频重建的对数。
  • 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之后的注意力权重,用于在自注意力头中计算加权平均值。

TvltForPreTraining 的 forward 方法重新定义了特殊方法 __call__

虽然需要在此函数内定义前向传递的配方,但应该调用 Module 实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import TvltProcessor, TvltForPreTraining
>>> import numpy as np
>>> import torch

>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> images_mixed = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))
>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltForPreTraining.from_pretrained("ZinengTang/tvlt-base")
>>> input_dict = processor(
...     images, audio, images_mixed, sampling_rate=44100, mask_pixel=True, mask_audio=True, return_tensors="pt"
... )

>>> outputs = model(**input_dict)
>>> loss = outputs.loss

TvltForAudioVisualClassification

transformers.TvltForAudioVisualClassification

< >

( config )

参数

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

Tvlt 模型,在顶部有一个用于音频视觉分类任务的分类头(在 [CLS] 标记的最终隐藏状态之上的 MLP),例如 CMU-MOSEI 情感分析和音频到视频检索。

本模型是PyTorch的torch.nn.Module子类。将其作为常规PyTorch模块使用,有关通用使用和行为的所有问题,请参阅PyTorch文档。

forward

< >

( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: Optional = None audio_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None labels: Optional = None ) transformers.modeling_outputs.SequenceClassifierOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_frames, num_channels, height, width)) — 像素值。使用TvltProcessor可以获得像素值。请参见TvltProcessor.call()获取详细信息。
  • audio_values (torch.FloatTensor 形状 (batch_size, num_channels, height, width)) — 音频值。音频值可以使用 TvltProcessor 获取。详情请见 TvltProcessor.call()
  • pixel_mask (torch.FloatTensor 形状 (batch_size, num_pixel_patches)) — 像素掩码。像素掩码可以使用 TvltProcessor 获取。详情请见 TvltProcessor.call()
  • audio_mask (torch.FloatTensor 形状 (batch_size, num_audio_patches)) — 音频掩码。音频掩码可以使用 TvltProcessor 获取。详情请见 TvltProcessor.call()
  • pixel_values_mixed (形状为 (batch_size, num_frames, num_channels, height, width)torch.FloatTensor)— 在 Tvlt 视觉-音频匹配中混合正负样本的像素值。可以通过使用 TvltProcessor 获取混合像素值。请参阅 TvltProcessor.call() 获取详细信息。
  • pixel_mask_mixed (形状为 (batch_size, num_channels, height, width)torch.FloatTensor)— pixel_values_mixed 的像素掩码。可以通过使用 TvltProcessor 获取混合像素掩码。请参阅 TvltProcessor.call() 获取详细信息。
  • mask_pixel (布尔值,可选)— 是否为 MAE 任务掩码像素。仅在 TvltForPreTraining 中设置为 True。
  • mask_audio (bool, 可选) — 是否对MAE任务进行音频遮蔽。仅在TvltForPreTraining中设置为True。
  • output_attentions (bool, 可选) — 是否返回所有注意层的注意张量。请参阅返回张量下的attentions获取更多信息。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。请参阅返回张量下的hidden_states获取更多信息。
  • return_dict (bool, 可选) —— 是否返回ModelOutput对象而不仅仅是元组。
  • labels (torch.LongTensor,形状 (batch_size, num_labels)可选) —— 用来计算音视频损失标签。索引应在 [0, ..., num_classes-1] 范围内,其中 num_classes 指的是音视频任务中的类别数量。

返回

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.SequenceClassifierOutput或一个torch.FloatTensor的元组(如果传递了return_dict=False或在配置中设置config.return_dict=False)包含根据配置(TvltConfig)和输入生成的各种元素。

  • loss (torch.FloatTensor,形状 (1,)可选,当提供labels时返回) —— 分类(当配置中num_labels等于1时为回归)损失。

  • logits (torch.FloatTensor,形状 (batch_size, config.num_labels)) —— 分类(当配置中num_labels等于1时为回归)分数(在SoftMax之前)。

  • 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后的注意力权重,用于在自注意力头中计算加权平均值。

TvltForAudioVisualClassification的forward方法覆盖了__call__特殊方法。

虽然需要在此函数内定义前向传递的配方,但应该调用 Module 实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import TvltProcessor, TvltForAudioVisualClassification
>>> import numpy as np
>>> import torch

>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))
>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltForAudioVisualClassification.from_pretrained("ZinengTang/tvlt-base")
>>> input_dict = processor(images, audio, sampling_rate=44100, return_tensors="pt")

>>> outputs = model(**input_dict)
>>> loss = outputs.loss
< > 在GitHub上更新