Transformers 文档

TVLT

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

TVLT

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

概述

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

论文摘要如下:

在这项工作中,我们提出了无文本视觉-语言 Transformer (TVLT),其中同构 Transformer 块采用原始视觉和音频输入,用于视觉和语言表示学习,并具有最少的模态特定设计,并且不使用文本特定的模块,如分词或自动语音识别 (ASR)。TVLT 通过重建连续视频帧和音频频谱图(掩码自动编码)的掩码补丁以及对比建模来对齐视频和音频进行训练。TVLT 在各种多模态任务(如视觉问答、图像检索、视频检索和多模态情感分析)上获得了与其基于文本的同类模型相当的性能,但推理速度快 28 倍,参数仅为后者的 1/3。我们的研究结果表明,有可能从低级视觉和音频信号中学习紧凑而高效的视觉语言表示,而无需假设文本的预先存在。

drawing

TVLT 架构。取自 原始论文

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

使用技巧

  • TVLT 是一个将 pixel_valuesaudio_values 作为输入的模型。可以使用 TvltProcessor 为模型准备数据。此处理器将图像处理器(用于图像/视频模态)和音频特征提取器(用于音频模态)包装在一起。
  • TVLT 使用各种尺寸的图像/视频和音频进行训练:作者将输入图像/视频调整大小并裁剪为 224,并将音频频谱图的长度限制为 2048。为了使视频和音频可以进行批处理,作者使用 pixel_mask 来指示哪些像素是真实的/填充的,并使用 audio_mask 来指示哪些音频值是真实的/填充的。
  • TVLT 的设计与标准 Vision Transformer (ViT) 和掩码自动编码器 (MAE) 非常相似,如 ViTMAE 中所示。不同之处在于该模型包括音频模态的嵌入层。
  • 此模型的 PyTorch 版本仅在 torch 1.10 及更高版本中可用。

TvltConfig

class 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_length (int, 可选, 默认为 128) — 音频频谱图的频率长度。
  • image_patch_size (List[int], 可选, 默认为 [16, 16]) — 每个图像补丁的大小(分辨率)。
  • audio_patch_size (List[int], 可选, 默认为 [16, 16]) — 每个音频补丁的大小(分辨率)。
  • num_image_channels (int, 可选, 默认为 3) — 输入图像通道的数量。
  • num_audio_channels (int, 可选, 默认为 1) — 输入音频通道的数量。
  • num_frames (int, 可选, 默认为 8) — 输入视频的最大帧数。
  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化器层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。
  • intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”层(即,前馈层)的维度。
  • hidden_act (strfunction, 可选, 默认为 "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) — 是否向 queries, keys 和 values 添加偏置。
  • 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 配置的配置类。它用于根据指定的参数实例化 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()。 有关更多信息,请参阅上述两种方法的文档字符串。

TvltImageProcessor

class 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 (bool, 可选, 默认为 True) — 是否将图像的(高度,宽度)尺寸调整为指定的 size。可以被 preprocess 方法中的 do_resize 参数覆盖。
  • size (Dict[str, int] 可选, 默认为 {"shortest_edge" -- 224}): 调整大小后输出图像的大小。图像的最短边将调整为 size["shortest_edge"],同时保持原始图像的纵横比。可以被 preprocess 方法中的 size 覆盖。
  • patch_size (List[int] 可选, 默认为 [16,16]) — 图像块嵌入的块大小。
  • num_frames (int 可选, 默认为 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, optional, 默认为 True) — 是否对图像进行标准化。可以被 preprocess 方法中的 do_normalize 参数覆盖。
  • image_mean (floatList[float], optional, 默认为 IMAGENET_STANDARD_MEAN) — 如果对图像进行标准化,则使用的均值。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以被 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (floatList[float], optional, 默认为 IMAGENET_STANDARD_STD) — 如果对图像进行标准化,则使用的标准差。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以被 preprocess 方法中的 image_std 参数覆盖。

构建 TVLT 图像处理器。

此处理器可以通过将图像转换为单帧视频,用于为模型准备视频或图像。

preprocess

< >

( videos: Union do_resize: bool = None size: Dict = None patch_size: List = None num_frames: int = None resample: Resampling = None do_center_crop: bool = None crop_size: Dict = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None is_mixed: bool = False return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None **kwargs ) BatchFeature

参数

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

class 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]) — 音频patch嵌入的 patch 大小。
  • feature_size (int, 可选的, 默认为 128) — 音频频谱图的频率长度。
  • sampling_rate (int, 可选的, 默认为 44100) — 音频文件应被数字化的采样率,以赫兹 (Hz) 表示。
  • hop_length_to_sampling_rate (int, 可选的, 默认为 86) — Hop length 是用于获取 Mel 频率系数的 STFT 的重叠窗口的长度。 例如,采样率为 44100 时,hop length 为 512,44100 / 512 = 86
  • n_fft (int, 可选的, 默认为 2048) — 傅里叶变换的大小。
  • padding_value (float, 可选的, 默认为 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, 可选的) — 如果设置,将返回 tensors 而不是 python 整数列表。 可接受的值为:

    • 'pt': 返回 PyTorch torch.Tensor 对象。
    • 'np': 返回 Numpy np.ndarray 对象。
  • return_attention_mask (bool, 可选的, 默认为 True) — 是否返回 attention mask。 如果保留为默认值,将根据特定 feature_extractor 的默认值返回 attention mask。 什么是 attention masks?

    对于 TvltTransformer 模型,应始终传递 attention_mask 以进行批量推理,以避免细微的错误。

  • sampling_rate (int, 可选的) — raw_speech 输入被采样的采样率。 强烈建议在前向调用中传递 sampling_rate,以防止静默错误并允许自动语音识别管道。 当前模型支持采样率 16000 和 44100。
  • resample (bool, 可选的, 默认为 False) — 如果采样率不匹配,则对输入音频进行重采样以匹配。
  • mask_audio (bool, 可选的, 默认为 False) — 是否为 MAE 任务屏蔽输入音频。

返回

BatchFeature

一个 BatchFeature,包含以下字段

  • audio_values — 要馈送到模型的音频值,形状为 (batch_size, num_channels, height, width)。

  • audio_mask — 要馈送到模型的音频 masks,形状为 (batch_size, num_audio_patches)。

准备一个或多个模型的音频的主要方法。

TvltModel

class transformers.TvltModel

< >

( config )

参数

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

裸 TVLT 模型 Transformer 输出原始隐藏状态,顶部没有任何特定的 head。 此模型是 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.TvltModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor,形状为 (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)) — 像素 masks。 像素 masks 可以使用 TvltProcessor 获得。 有关详细信息,请参见 TvltProcessor.call()
  • audio_mask (torch.FloatTensor,形状为 (batch_size, num_audio_patches)) — 音频 masks。 音频 masks 可以使用 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 的像素 masks。 混合的像素 masks 可以使用 TvltProcessor 获得。 有关详细信息,请参见 TvltProcessor.call()
  • mask_pixel (bool, 可选的) — 是否为 MAE 任务屏蔽像素。 仅在 TvltForPreTraining 中设置为 True。
  • mask_audio (bool, 可选的) — 是否为 MAE 任务屏蔽音频。 仅在 TvltForPreTraining 中设置为 True。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯元组。

返回

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

一个 transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutputtorch.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.FloatTensor,形状为 (batch_size, pixel_sequence_length, hidden_size)) — 模型最后一层的输出处的像素隐藏状态序列。
  • last_audio_hidden_state (torch.FloatTensor,形状为 (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)) — 张量包含像素掩码的 id 排列。
  • audio_ids_restore (torch.LongTensor,形状为 (batch_size, audio_patch_length)) — 张量包含音频掩码的 id 排列。
  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(每个嵌入输出一个,每个层的输出一个),形状为 (batch_size, sequence_length, hidden_size)。 模型在每一层输出处的隐藏状态,加上初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。 注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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

TvltForPreTraining

class transformers.TvltForPreTraining

< >

( 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 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 (torch.FloatTensor,形状为 (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 (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, optional) — 是否为 MAE 任务掩码像素。 仅在 TvltForPreTraining 中设置为 True。
  • mask_audio (bool, optional) — 是否为 MAE 任务掩码音频。 仅在 TvltForPreTraining 中设置为 True。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 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), optional) — 用于计算视觉音频匹配损失的标签。 索引应在 [0, 1] 中。 num_labels 必须为 1。

返回

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

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

  • loss (torch.FloatTensor,形状为 (1,)) — 像素重建损失。
  • matching_logits (torch.FloatTensor,形状为 (batch_size, 1)) — 匹配目标 logits。
  • pixel_logits (torch.FloatTensor,形状为 (batch_size, pixel_patch_length, image_patch_size ** 3 * pixel_num_channels)): 像素重建 logits。
  • audio_logits (torch.FloatTensor,形状为 (batch_size, audio_patch_length, image_patch_size[0] * image_patch_size[1])): 音频重建 logits。
  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(每个嵌入输出一个,每个层的输出一个),形状为 (batch_size, sequence_length, hidden_size)。 模型在每一层输出处的隐藏状态,加上初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。 注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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

class 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.SequenceClassifierOutputtuple(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 (形状为 (batch_size, num_pixel_patches)torch.FloatTensor) — 像素掩码。像素掩码可以使用 TvltProcessor 获得。 有关详细信息,请参阅 TvltProcessor.call()
  • audio_mask (形状为 (batch_size, num_audio_patches)torch.FloatTensor) — 音频掩码。音频掩码可以使用 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 (bool, 可选) — 是否为 MAE 任务掩码像素。仅在 TvltForPreTraining 中设置为 True。
  • mask_audio (bool, 可选) — 是否为 MAE 任务掩码音频。仅在 TvltForPreTraining 中设置为 True。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (形状为 (batch_size, num_labels)torch.LongTensor, 可选) — 用于计算视听损失的标签。索引应为 [0, ..., num_classes-1],其中 num_classes 指的是视听任务中的类别数。

返回

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutputtorch.FloatTensor 元组 (如果传递 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (TvltConfig) 和输入。

  • loss (形状为 (1,)torch.FloatTensor, 可选, 当提供 labels 时返回) — 分类(或回归,如果 config.num_labels==1)损失。

  • logits (形状为 (batch_size, config.num_labels)torch.FloatTensor) — 分类(或回归,如果 config.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 前向方法,覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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 上更新