Transformers 文档

FLAVA

FLAVA

概述

FLAVA模型由Amanpreet Singh、Ronghang Hu、Vedanuj Goswami、Guillaume Couairon、Wojciech Galuba、Marcus Rohrbach和Douwe Kiela在FLAVA: A Foundational Language And Vision Alignment Model中提出,并被CVPR 2022接受。

本文旨在创建一个单一的统一基础模型,该模型可以跨视觉、语言以及视觉和语言多模态任务工作。

论文的摘要如下:

最先进的视觉和视觉-语言模型依赖于大规模的视觉-语言预训练,以在各种下游任务中获得良好的性能。通常,这些模型要么是跨模态的(对比的),要么是多模态的(早期融合),但不同时具备两者;而且它们通常只针对特定的模态或任务。一个有前景的方向是使用一个单一的整体通用模型作为“基础”,同时针对所有模态——一个真正的视觉和语言基础模型应该在视觉任务、语言任务以及跨模态和多模态的视觉和语言任务中表现出色。我们介绍了FLAVA作为这样一个模型,并在涵盖这些目标模态的35个任务中展示了令人印象深刻的性能。

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

FlavaConfig

transformers.FlavaConfig

< >

( image_config: typing.Dict[str, typing.Any] = None text_config: typing.Dict[str, typing.Any] = None multimodal_config: typing.Dict[str, typing.Any] = None image_codebook_config: typing.Dict[str, typing.Any] = None hidden_size: int = 768 layer_norm_eps: float = 1e-12 projection_dim: int = 768 init_codebook: bool = True logit_scale_init_value: float = 2.6592 initializer_range: float = 0.02 ce_ignore_index: int = -100 mim_weight: float = 1.0 mlm_weight: float = 1.0 global_contrastive_weight: float = 1.0 itm_weight: float = 1.0 mmm_image_weight: float = 1.0 mmm_text_weight: float = 1.0 global_backprop_contrastive: bool = True skip_unmasked_multimodal_encoder: bool = True return_loss: bool = True **kwargs )

参数

  • text_config (dict, 可选) — 用于初始化 FlavaTextConfig 的配置选项字典.
  • image_config (dict, 可选) — 用于初始化 FlavaImageConfig 的配置选项字典.
  • multimodal_config (dict, optional) — 用于初始化FlavaMultimodalConfig的配置选项字典。
  • hidden_size (int, optional, 默认为 768) — 编码器层和池化层的维度。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon值。
  • projection_dim (int, 可选, 默认为 512) — 文本和图像投影层的维度.
  • logit_scale_init_value (float, optional, 默认为 2.6592) — logit_scale 参数的初始值。默认值按照原始 FLAVA/CLIP 实现使用。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • ce_ignore_index (int, optional, 默认为 -100) — 要忽略的交叉熵索引.
  • mim_weight (float, optional, defaults to 1.0) — 分配给MIM(掩码图像建模)单模态损失的权重
  • mlm_weight (float, optional, 默认为 1.0) — 分配给 MLM(掩码语言建模)单模态损失的权重
  • global_contrastive_weight (float, optional, defaults to 1.0) — 分配给全局对比交叉对齐损失的权重。
  • itm_weight (float, optional, 默认为 1.0) — 分配给图像-文本匹配多模态损失的权重。
  • mmm_image_weight (float, optional, defaults to 1.0) — 分配给MMM损失的图像部分的权重。
  • mmm_text_weight (float, optional, 默认为 1.0) — 分配给 MMM 损失的文本部分的权重。
  • global_backprop_contrastive (bool, 可选, 默认为 True) — 是否在所有工作节点中使用全局反向传播来计算对比损失。
  • skip_unmasked_multimodal_encoder (bool, 可选, 默认为 True) — 是否跳过运行未屏蔽的多模态编码器,其输出不被FLAVA损失使用。
  • return_loss (bool, optional, defaults to True) — 是否返回损失
  • kwargs (可选) — 关键字参数字典。

FlavaConfig 是用于存储 FlavaModel 配置的配置类。它用于根据指定的参数实例化 FLAVA 模型,定义文本模型、图像模型、图像代码本和多模态模型配置。使用默认值实例化配置将产生与 FLAVA facebook/flava-full 架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import FlavaConfig, FlavaModel, FlavaForPreTraining

>>> # Initializing a FlavaConfig with style configuration
>>> configuration = FlavaConfig()

>>> # Initializing a FlavaModel and FlavaForPreTraining model (with random weights) from the style configuration
>>> model = FlavaModel(configuration)
>>> model_pre = FlavaForPreTraining(configuration)

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

from_configs

< >

( image_config: FlavaImageConfig text_config: FlavaTextConfig multimodal_config: FlavaMultimodalConfig image_codebook_config: FlavaImageCodebookConfig **kwargs ) FlavaConfig

返回

FlavaConfig

配置对象的一个实例

从flava文本模型配置、flava图像模型配置、flava多模态模型和flava代码本模型配置中实例化一个FlavaConfig(或派生类)。

FlavaTextConfig

transformers.FlavaTextConfig

< >

( vocab_size: int = 30522 type_vocab_size: int = 2 max_position_embeddings: int = 512 position_embedding_type: str = 'absolute' hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: str = 'gelu' hidden_dropout_prob: float = 0.0 attention_probs_dropout_prob: float = 0.0 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 pad_token_id: int = 0 qkv_bias: bool = True **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — BERT模型的词汇表大小。定义了调用FlavaTextModel时传递的inputs_ids可以表示的不同标记的数量。
  • type_vocab_size (int, 可选, 默认为 2) — 调用 FlavaTextModel 时传递的 token_type_ids 的词汇表大小。请注意,尽管 文本编码器允许 token_type_ids 的值为 2,但在仅文本的预训练和微调中,仅使用 1, 类似于 RoBERTa。
  • max_position_embeddings (int, optional, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一(例如,512、1024 或 2048)。对于 VL,传递给模型的 max_length 为 77。
  • position_embedding_type (str, optional, defaults to "absolute") — 位置嵌入的类型。选择 "absolute", "relative_key", "relative_key_query" 中的一个。对于 位置嵌入,使用 "absolute"。有关 "relative_key" 的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。 有关 "relative_key_query" 的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 Method 4
  • hidden_size (int, optional, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, optional, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, optional, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • hidden_act (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, optional, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, optional, 默认为 0.1) — 注意力概率的丢弃比例。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon值。
  • image_size (int, optional, defaults to 224) — 每张图片的大小(分辨率)。
  • patch_size (int, optional, defaults to 16) — 每个补丁的大小(分辨率)。
  • num_channels (int, optional, defaults to 3) — 输入通道的数量。
  • qkv_bias (bool, optional, defaults to True) — 是否向查询、键和值添加偏置。

这是用于存储FlavaTextModel配置的配置类。它用于根据指定的参数实例化一个FLAVA模型,定义模型架构。

使用默认值实例化配置将产生与FLAVA facebook/flava-full 架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import FlavaTextConfig, FlavaTextModel

>>> # Initializing a FlavaTextModel with  style configuration
>>> configuration = FlavaTextConfig()

>>> # Initializing a FlavaTextModel model (with random weights) from the style configuration
>>> model = FlavaTextModel(configuration)

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

FlavaImageConfig

transformers.FlavaImageConfig

< >

( hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: int = 'gelu' hidden_dropout_prob: float = 0.0 attention_probs_dropout_prob: float = 0.0 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 image_size: int = 224 patch_size: int = 16 num_channels: int = 3 qkv_bias: bool = True mask_token: bool = True vocab_size: int = 8192 **kwargs )

参数

  • hidden_size (int, optional, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, optional, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 12) — Transformer编码器中每个注意力层的注意力头数。
  • intermediate_size (int, optional, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • hidden_act (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu", "relu", "selu""gelu_new".
  • hidden_dropout_prob (float, optional, 默认为 0.0) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, optional, 默认为 0.0) — 注意力概率的丢弃比例。
  • initializer_range (float, 可选, 默认值为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon值。
  • image_size (int, optional, 默认为 224) — 每张图片的大小(分辨率)。
  • patch_size (int, optional, defaults to 16) — 每个补丁的大小(分辨率)。
  • num_channels (int, optional, defaults to 3) — 输入通道的数量。
  • qkv_bias (bool, 可选, 默认为 True) — 是否向查询、键和值添加偏置。
  • mask_token (bool, 可选, 默认为 True) — 是否使用掩码标记。用于FLAVA的MIM(掩码图像建模)损失中。
  • vocab_size (int, 可选, 默认为 8192) — 与FlavaImageModel一起使用的FlavaImageCodebook的词汇表大小,用于FLAVA的MIM(掩码图像建模)损失。

这是用于存储FlavaImageModel配置的配置类。它用于根据指定的参数实例化一个FLAVA模型,定义模型架构。

使用默认值实例化配置将产生与FLAVA facebook/flava-full 架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import FlavaImageConfig, FlavaImageModel

>>> # Initializing a FlavaImageModel with  style configuration
>>> configuration = FlavaImageConfig()

>>> # Initializing a FlavaImageModel model (with random weights) from the style configuration
>>> model = FlavaImageModel(configuration)

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

FlavaMultimodalConfig

transformers.FlavaMultimodalConfig

< >

( hidden_size: int = 768 num_hidden_layers: int = 6 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: int = 'gelu' hidden_dropout_prob: int = 0.0 attention_probs_dropout_prob: int = 0.0 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 qkv_bias: bool = True use_cls_token: bool = True **kwargs )

参数

  • hidden_size (int, optional, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 6) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。
  • intermediate_size (int, optional, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • hidden_act (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, optional, 默认为 0.0) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, optional, defaults to 0.0) — 注意力概率的丢弃比例。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon值。
  • qkv_bias (bool, optional, defaults to True) — 是否向查询、键和值添加偏置。
  • use_cls_token (bool, 可选, 默认为 True) — 是否在多模态设置中使用额外的CLS令牌。通常由FLAVA模型需要。

这是用于存储FlavaMultimodalModel配置的配置类。它用于根据指定的参数实例化FLAVA模型,定义模型架构。

使用默认值实例化配置将产生与FLAVA facebook/flava-full 架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import FlavaMultimodalConfig, FlavaMultimodalModel

>>> # Initializing a FlavaMultimodalModel with  style configuration
>>> configuration = FlavaMultimodalConfig()

>>> # Initializing a FlavaMultimodalModel model (with random weights) from the style configuration
>>> model = FlavaMultimodalModel(configuration)

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

FlavaImageCodebookConfig

transformers.FlavaImageCodebookConfig

< >

( num_groups: int = 4 input_channels: int = 3 num_blocks_per_group: int = 2 hidden_size: int = 256 vocab_size: int = 8192 freeze: int = True initializer_range: float = 0.02 **kwargs )

FlavaProcessor

transformers.FlavaProcessor

< >

( image_processor = 无 tokenizer = 无 **kwargs )

参数

构建一个FLAVA处理器,它将FLAVA图像处理器和FLAVA分词器封装成一个单一的处理器。

FlavaProcessor 提供了 FlavaImageProcessorBertTokenizerFast 的所有功能。更多信息请参见 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发给BertTokenizerFast的batch_decode()。请参考该方法的文档字符串以获取更多信息。

解码

< >

( *args **kwargs )

此方法将其所有参数转发给BertTokenizerFast的decode()。请参考该方法的文档字符串以获取更多信息。

FlavaFeatureExtractor

transformers.FlavaFeatureExtractor

< >

( *args **kwargs )

FlavaImageProcessor

transformers.FlavaImageProcessor

< >

( do_resize: bool = True size: typing.Dict[str, int] = None resample: Resampling = do_center_crop: bool = True crop_size: typing.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, typing.Iterable[float], NoneType] = None image_std: typing.Union[float, typing.Iterable[float], NoneType] = None return_image_mask: bool = False input_size_patches: int = 14 total_mask_patches: int = 75 mask_group_min_patches: int = 16 mask_group_max_patches: typing.Optional[int] = None mask_group_min_aspect_ratio: float = 0.3 mask_group_max_aspect_ratio: typing.Optional[float] = None return_codebook_pixels: bool = False codebook_do_resize: bool = True codebook_size: bool = None codebook_resample: int = codebook_do_center_crop: bool = True codebook_crop_size: int = None codebook_do_rescale: bool = True codebook_rescale_factor: typing.Union[int, float] = 0.00392156862745098 codebook_do_map_pixels: bool = True codebook_do_normalize: bool = True codebook_image_mean: typing.Union[float, typing.Iterable[float], NoneType] = None codebook_image_std: typing.Union[float, typing.Iterable[float], NoneType] = None **kwargs )

参数

  • do_resize (bool, 可选, 默认为 True) — 是否将图像的(高度,宽度)尺寸调整为指定的 size。可以在 preprocess 中通过 do_resize 参数覆盖此设置。
  • size (Dict[str, int] 可选, 默认为 {"height" -- 224, "width": 224}): 调整大小后的图像尺寸。可以通过 preprocess 中的 size 参数覆盖。
  • resample (PILImageResampling, 可选, 默认为 PILImageResampling.BICUBIC) — 如果调整图像大小,则使用的重采样过滤器。可以在 preprocess 中通过 resample 参数覆盖。
  • do_center_crop (bool, 可选, 默认为 True) — 是否对图像进行中心裁剪。可以通过 preprocess 中的 do_center_crop 参数进行覆盖。
  • crop_size (Dict[str, int] 可选, 默认为 {"height" -- 224, "width": 224}): 图像中心裁剪后的大小 (crop_size["height"], crop_size["width"])。可以通过 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 参数进行覆盖。
  • return_image_mask (bool, 可选, 默认为 False) — 是否返回图像掩码。可以在 preprocess 中通过 return_image_mask 参数覆盖此设置。
  • input_size_patches (int, 可选, 默认为 14) — 图像中高度和宽度方向上的补丁数量。14x14 = 196 个总补丁。可以通过 preprocess 中的 input_size_patches 参数进行覆盖。
  • total_mask_patches (int, 可选, 默认为 75) — 应该被掩码的补丁总数。可以通过 preprocess 中的 total_mask_patches 参数进行覆盖。
  • mask_group_min_patches (int, 可选, 默认为 16) — 应被掩码的最小补丁数。可以通过 preprocess 中的 mask_group_min_patches 参数覆盖。
  • mask_group_max_patches (int, 可选) — 应被屏蔽的最大补丁数。可以在preprocess中通过mask_group_max_patches参数覆盖此设置。
  • mask_group_min_aspect_ratio (float, 可选, 默认为 0.3) — 掩码窗口的最小宽高比。可以通过 preprocess 中的 mask_group_min_aspect_ratio 参数进行覆盖。
  • mask_group_max_aspect_ratio (float, 可选) — 遮罩窗口的最大宽高比。可以通过preprocess中的mask_group_max_aspect_ratio参数进行覆盖。
  • codebook_do_resize (bool, 可选, 默认为 True) — 是否将输入的codebook调整为特定大小。可以通过preprocess中的codebook_do_resize参数覆盖。codebook_size.
  • codebook_size (Dict[str, int], 可选, 默认为 {"height" -- 224, "width": 224}): 将输入的codebook调整为给定大小。可以通过preprocess中的codebook_size参数进行覆盖。
  • codebook_resample (PILImageResampling, 可选, 默认为 PILImageResampling.LANCZOS) — 如果调整代码簿图像的大小,则使用的重采样过滤器。可以在 preprocess 中通过 codebook_resample 参数覆盖。
  • codebook_do_center_crop (bool, 可选, 默认为 True) — 是否在中心裁剪输入以用于codebook。如果输入尺寸在任何边缘小于 codebook_crop_size,图像将用0填充,然后进行中心裁剪。可以通过 preprocess中的codebook_do_center_crop参数覆盖此设置。
  • codebook_crop_size (Dict[str, int], 可选, 默认为 {"height" -- 224, "width": 224}): 在应用中心裁剪时,codebook输入的期望输出大小。可以通过preprocess中的codebook_crop_size参数进行覆盖。
  • codebook_do_rescale (bool, optional, defaults to True) — 是否通过指定的比例 codebook_rescale_factor 对输入进行重新缩放。可以在 preprocess 中通过 codebook_do_rescale 参数进行覆盖。
  • codebook_rescale_factor (intfloat, 可选, 默认为 1/255) — 定义在重新缩放码本图像时使用的比例因子。可以通过 preprocess 中的 codebook_rescale_factor 参数进行覆盖。
  • codebook_do_map_pixels (bool, 可选, 默认为 True) — 是否将codebook输入的像素值映射到(1 - 2e)x + e。可以通过preprocess中的codebook_do_map_pixels参数进行覆盖。
  • codebook_do_normalize (bool, 可选, 默认为 True) — 是否使用 codebook_image_meancodebook_image_std 对输入进行归一化。可以在 preprocess 中通过 codebook_do_normalize 参数进行覆盖。
  • codebook_image_mean (Optional[Union[float, Iterable[float]]], 可选, 默认为 [0, 0, 0]) — 用于在归一化图像以生成代码书时使用的每个通道的均值序列。可以通过preprocess中的codebook_image_mean参数进行覆盖。
  • codebook_image_std (Optional[Union[float, Iterable[float]]], 可选, 默认为 [0.5, 0.5, 0.5]) — 用于在归一化图像以生成代码书时,每个通道的标准差序列。可以通过 preprocess 中的 codebook_image_std 参数进行覆盖。

构建一个Flava图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), typing.List[ForwardRef('PIL.Image.Image')], typing.List[numpy.ndarray], typing.List[ForwardRef('torch.Tensor')]] do_resize: typing.Optional[bool] = None size: typing.Dict[str, int] = None resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[typing.Dict[str, 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, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None return_image_mask: typing.Optional[bool] = None input_size_patches: typing.Optional[int] = None total_mask_patches: typing.Optional[int] = None mask_group_min_patches: typing.Optional[int] = None mask_group_max_patches: typing.Optional[int] = None mask_group_min_aspect_ratio: typing.Optional[float] = None mask_group_max_aspect_ratio: typing.Optional[float] = None return_codebook_pixels: typing.Optional[bool] = None codebook_do_resize: typing.Optional[bool] = None codebook_size: typing.Optional[typing.Dict[str, int]] = None codebook_resample: typing.Optional[int] = None codebook_do_center_crop: typing.Optional[bool] = None codebook_crop_size: typing.Optional[typing.Dict[str, int]] = None codebook_do_rescale: typing.Optional[bool] = None codebook_rescale_factor: typing.Optional[float] = None codebook_do_map_pixels: typing.Optional[bool] = None codebook_do_normalize: typing.Optional[bool] = None codebook_image_mean: typing.Optional[typing.Iterable[float]] = None codebook_image_std: typing.Optional[typing.Iterable[float]] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

参数

  • 图像 (ImageInput) — 要预处理的图像。期望输入单个或批量的图像,像素值范围在0到255之间。如果传入的图像像素值在0到1之间,请设置 do_rescale=False.
  • do_resize (bool, optional, defaults to self.do_resize) — 是否调整图像大小.
  • size (Dict[str, int], 可选, 默认为 self.size) — 图像的大小.
  • resample (int, 可选, 默认为 self.resample) — 如果调整图像大小,则使用的重采样过滤器。这可以是枚举 PILImageResampling 之一,仅在 do_resize 设置为 True 时有效。
  • do_center_crop (bool, optional, defaults to self.do_center_crop) — 是否对图像进行中心裁剪。
  • crop_size (Dict[str, int], 可选, 默认为 self.crop_size) — 中心裁剪的大小。仅在 do_center_crop 设置为 True 时有效。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否将图像值缩放到 [0 - 1] 之间。
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 如果do_rescale设置为True,则用于重新缩放图像的重新缩放因子。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对图像进行归一化处理.
  • image_mean (floatList[float], 可选, 默认为 self.image_mean) — 图像均值.
  • image_std (float or List[float], optional, defaults to self.image_std) — 图像标准差.
  • return_image_mask (bool, optional, defaults to self.return_image_mask) — 是否返回图像掩码。
  • input_size_patches (int, optional, defaults to self.input_size_patches) — 从图像中提取的补丁的大小。
  • total_mask_patches (int, optional, defaults to self.total_mask_patches) — 从图像中提取的补丁总数。
  • mask_group_min_patches (int, optional, defaults to self.mask_group_min_patches) — 从图像中提取的最小补丁数。
  • mask_group_max_patches (int, optional, defaults to self.mask_group_max_patches) — 从图像中提取的最大补丁数。
  • mask_group_min_aspect_ratio (float, 可选, 默认为 self.mask_group_min_aspect_ratio) — 从图像中提取的补丁的最小宽高比。
  • mask_group_max_aspect_ratio (float, 可选, 默认为 self.mask_group_max_aspect_ratio) — 从图像中提取的补丁的最大宽高比。
  • return_codebook_pixels (bool, 可选, 默认为 self.return_codebook_pixels) — 是否返回码本像素.
  • codebook_do_resize (bool, optional, defaults to self.codebook_do_resize) — 是否调整代码书像素的大小.
  • codebook_size (Dict[str, int], optional, defaults to self.codebook_size) — 代码书像素的大小.
  • codebook_resample (int, 可选, 默认为 self.codebook_resample) — 如果调整码本像素大小,则使用的重采样过滤器。这可以是枚举 PILImageResampling 中的一个,仅在 codebook_do_resize 设置为 True 时有效。
  • codebook_do_center_crop (bool, optional, defaults to self.codebook_do_center_crop) — 是否对代码书像素进行中心裁剪。
  • codebook_crop_size (Dict[str, int], 可选, 默认为 self.codebook_crop_size) — 代码书像素的中心裁剪大小。仅在 codebook_do_center_crop 设置为 True 时有效。
  • codebook_do_rescale (bool, 可选, 默认为 self.codebook_do_rescale) — 是否将代码本像素值重新缩放到 [0 - 1] 之间。
  • codebook_rescale_factor (float, 可选, 默认为 self.codebook_rescale_factor) — 如果 codebook_do_rescale 设置为 True,则用于重新调整代码簿像素的重新调整因子。
  • codebook_do_map_pixels (bool, optional, defaults to self.codebook_do_map_pixels) — 是否映射代码簿像素值。
  • codebook_do_normalize (bool, 可选, 默认为 self.codebook_do_normalize) — 是否对代码书像素进行归一化。
  • codebook_image_mean (floatList[float], 可选, 默认为 self.codebook_image_mean) — 如果 codebook_do_normalize 设置为 True,则用于归一化代码本像素的代码本像素均值。
  • codebook_image_std (floatList[float], 可选, 默认为 self.codebook_image_std) — 如果 codebook_do_normalize 设置为 True,则用于归一化代码书像素的代码书像素标准差。
  • 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) — 输出图像的通道维度格式。可以是以下之一:
    • 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)。

预处理一张图像或一批图像。

FlavaForPreTraining

transformers.FlavaForPreTraining

< >

( config: FlavaConfig image_codebook: typing.Optional[torch.nn.modules.module.Module] = None )

参数

  • config (FlavaConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
  • image_codebook (nn.Module) — 如果传递了,图像码本将被设置为这个。否则,它将首先使用配置中定义的image_codebook_config作为第一个参数进行初始化。

FLAVA预训练模型,输出损失、嵌入、逻辑值和变压器输出。

该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None input_ids_masked: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None codebook_pixel_values: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None image_attention_mask: typing.Optional[torch.Tensor] = None skip_unmasked_multimodal_encoder: bool = None mlm_labels: typing.Optional[torch.Tensor] = None mim_labels: typing.Optional[torch.Tensor] = None itm_labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: bool = True return_dict: typing.Optional[bool] = None return_loss: typing.Optional[bool] = None ) transformers.models.flava.modeling_flava.FlavaForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • input_ids_masked (torch.LongTensor of shape (batch_size, text_seq_len)) — 词汇表中输入序列标记的索引。这些是原始任务的掩码版本,用于MLM。可以使用AutoTokenizerDataCollatorForMaskedLanguageModeling获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • input_ids (torch.LongTensor of shape (batch_size, text_seq_len)) — 词汇表中输入序列标记的索引。可以使用AutoTokenizer获取索引。详情请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • token_type_ids (torch.LongTensor of shape (batch_size, text_seq_len), optional) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择:
  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见 FlavaImageProcessor.call().
  • bool_masked_pos (torch.BoolTensor of shape (batch_size, image_num_patches)) — 布尔掩码位置。指示哪些补丁被掩码(1)和哪些没有被掩码(0)。
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • image_attention_mask (torch.FloatTensor of shape (batch_size, image_num_patches), optional) — 用于避免在图像的填充标记索引上执行注意力机制的掩码。掩码值在 [0, 1] 中选择:
  • skip_unmasked_multimodal_encoder (bool, optional) — 跳过未屏蔽输入的多模态编码器的任何计算。目前,FLAVA预训练不需要未屏蔽的多模态嵌入或输出。
  • mlm_labels (torch.LongTensor of shape (batch_size, text_seq_len), optional) — 用于计算从左到右的语言和多模态掩码建模损失(下一个词预测)的标签。 索引应在 [-100, 0, ..., text_config.vocab_size - 1] 范围内(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., text_config.vocab_size - 1] 范围内的标记计算。
  • mim_labels (torch.LongTensor of shape (batch_size, image_num_patches), optional) — 用于计算图像和多模态掩码建模损失的标签。索引应在 [-100, 0, ..., image_config.vocab_size - 1] 范围内。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., image_config.vocab_size - 1] 范围内的标记计算。如果未传递,它们将使用分配给模型的图像代码书自动生成。默认情况下,它使用 FlavaImageCodebook。请参阅 FlavaImageCodebook 以了解如何生成 mim_labels。
  • itm_labels (torch.LongTensor of shape (batch_size, 1), optional) — 用于计算图像-文本匹配损失的标签。0表示对不匹配,1表示匹配。 对于MMM和全局对比损失的计算,0的对将被跳过。
  • return_loss (bool, optional, default to None) — 是否返回计算出的损失。
  • attention_mask (torch.FloatTensor of shape (batch_size, text_seq_len), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • 示例
  • ```python

    从PIL导入图像 导入请求 从transformers导入FlavaForPreTraining, AutoProcessor

返回

transformers.models.flava.modeling_flava.FlavaForPreTrainingOutputtuple(torch.FloatTensor)

一个 transformers.models.flava.modeling_flava.FlavaForPreTrainingOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置()和输入而定的各种元素。

  • loss (torch.FloatTensor, 可选, 当 return_loss 为 True 时返回) — 为此模型计算的总损失。

  • loss_info (FlavaLosses) — FLAVA 预训练损失的详细信息。请查看 FlavaLosses 类的描述以获取有关键的信息。

  • image_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 pixel_values 存在时返回) — 图像嵌入,基本上是 FlavaImageModel 的池化输出。

  • image_output (BaseModelOutputWithPooling, 可选, 当 pixel_values 存在时返回) — FlavaImageModel 的输出。

  • text_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_ids 存在时返回) — 文本嵌入,基本上是 FlavaTextModel 的池化输出。

  • text_output (BaseModelOutputWithPooling, 可选, 当 input_ids 存在时返回) — FlavaTextModel 的输出。

  • multimodal_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_idspixel_values 存在且 skip_unmasked_multimodal_encoderNoneFalse 时返回) — 多模态嵌入,基本上是 FlavaTextModel 的池化输出。

  • multimodal_output (BaseModelOutputWithPooling, 当 input_idspixel_values 存在且 skip_unmasked_multimodal_encoderNoneFalse 时返回) — FlavaMultimodalModel 的输出。

  • image_masked_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 pixel_values 存在时返回) — 图像嵌入,基本上是 FlavaImageModel 的池化输出。使用 bool_masked_pos 创建掩码图像。

  • image_masked_output (BaseModelOutputWithPooling, 可选, 当 pixel_values 存在时返回) — FlavaImageModel 的输出。使用 bool_masked_pos 创建掩码图像。

  • text_masked_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_ids_masked 存在时返回) — 文本嵌入,基本上是 FlavaTextModel 的池化输出。

  • text_masked_output (BaseModelOutputWithPooling, 可选, 当 input_ids_masked 存在时返回) — FlavaTextModel 的输出。

  • multimodal_masked_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_idspixel_values 存在时返回) — 多模态嵌入,基本上是 FlavaTextModel 的池化输出。

  • multimodal_masked_output (BaseModelOutputWithPooling, 可选, 当 input_ids_maskedpixel_values 存在时返回) — FlavaMultimodalModel 的输出。

  • mim_logits (torch.FloatTensor 形状为 (batch_size, num_image_patches, image_vocab_size) 或形状为 (total_masked_patches, image_vocab_size), 可选, 当 pixel_values 存在且 input_ids_masked 不存在时返回) — MIM 单模态损失的 logits。使用 book_masked_pos 获取掩码补丁。当 bool_masked_pos 有部分补丁被掩码时,返回扁平化输出。

  • mlm_logits (torch.FloatTensor 形状为 (batch_size, text_seq_length, text_vocab_size) 或形状为 (total_masked_seq_length, text_vocab_size), 可选, 当 input_ids_masked 存在且 pixel_values 不存在时返回) — MLM 单模态损失的 logits。当 input_ids_masked 有部分 token 被掩码时,返回扁平化输出。

  • itm_logits (torch.FloatTensor 形状为 (batch_size, 2), 可选, 当 input_ids_maskedpixel_values 存在时返回) — ITM 损失的 logits。请注意,ITM 损失是在 FLAVA 中的掩码对上计算的。

  • mmm_image_logits (torch.FloatTensor 形状为 (batch_size, num_image_patches, image_vocab_size) 或形状为 (total_masked_patches, image_vocab_size), 可选, 当 pixel_valuesinput_ids_masked 存在时返回) — MMM 图像多模态损失的 logits。使用 book_masked_pos 获取掩码补丁。当 bool_masked_pos 有部分补丁被掩码时,返回扁平化输出。

  • mmm_text_logits (torch.FloatTensor 形状为 (batch_size, text_seq_length, text_vocab_size) 或形状为 ((total_masked_seq_length, text_vocab_size)), *可选*, 当 pixel_valuesinput_ids_masked存在时返回) -- MMM 文本多模态损失的 logits。当input_ids_masked` 有部分 token 被掩码时,返回扁平化输出。

  • contrastive_logits_per_image (torch.FloatTensor 形状为 (image_batch_size, text_batch_size)) — image_embeddingstext_embeddings 之间的缩放点积分数,但分别通过 FLAVA 的 image_projectiontext_projection 层传递。这表示图像-文本相似性分数。这是在未掩码的图像和文本上计算的。

  • contrastive_logits_per_text (torch.FloatTensor 形状为 (text_batch_size, image_batch_size)) — text_embeddingsimage_embeddings 之间的缩放点积分数,但分别通过 FLAVA 的 text_projectionimage_projection 层传递。这是在未掩码的图像和文本上计算的。

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

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

FlavaModel

transformers.FlavaModel

< >

( config: FlavaConfig )

参数

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

裸的FLAVA模型变压器输出原始隐藏状态,没有任何特定的头部。 该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None image_attention_mask: typing.Optional[torch.Tensor] = None skip_multimodal_encoder: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: bool = True return_dict: typing.Optional[bool] = None ) transformers.models.flava.modeling_flava.FlavaModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见 FlavaImageProcessor.call().
  • bool_masked_pos (torch.BoolTensor of shape (batch_size, image_num_patches)) — 布尔掩码位置。指示哪些补丁被掩码(1)和哪些没有被掩码(0)。
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • input_ids (torch.LongTensor of shape (batch_size, image_num_patches + text_seq_len)) — 词汇表中输入序列标记的索引。可以使用AutoTokenizer获取索引。详情请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • token_type_ids (torch.LongTensor of shape (batch_size, image_num_patches + text_seq_len), optional) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择:
  • attention_mask (torch.FloatTensor of shape (batch_size, image_num_patches + text_seq_len), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • skip_multimodal_encoder (bool, optional) — 跳过任何多模态编码器的计算。如果不需要使用多模态编码,这将非常有用。

返回

transformers.models.flava.modeling_flava.FlavaModelOutputtuple(torch.FloatTensor)

一个 transformers.models.flava.modeling_flava.FlavaModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置()和输入而定的各种元素。

  • image_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 pixel_values 存在时返回) — 图像嵌入,基本上是 FlavaImageModel 的池化输出。
  • image_output (BaseModelOutputWithPooling, 可选, 当 pixel_values 存在时返回) — FlavaImageModel 的输出。
  • text_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_ids 存在时返回) — 文本嵌入,基本上是 FlavaTextModel 的池化输出。
  • text_output (BaseModelOutputWithPooling, 可选, 当 input_ids 存在时返回) — FlavaTextModel 的输出。
  • multimodal_embeddings (torch.FloatTensor 形状为 (batch_size, output_dim), 可选, 当 input_idspixel_values 存在且 skip_multimodal_encoderNoneFalse 时返回) — 多模态嵌入,基本上是 FlavaTextModel 的池化输出。
  • multimodal_output (BaseModelOutputWithPooling, 当 input_idspixel_values 存在且 skip_multimodal_encoderNoneFalse 时返回) — FlavaMultimodalModel 的输出。

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

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

示例:

>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, FlavaModel

>>> model = FlavaModel.from_pretrained("facebook/flava-full")
>>> processor = AutoProcessor.from_pretrained("facebook/flava-full")

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = processor(text=["a photo of a cat"], images=image, return_tensors="pt", padding=True)

>>> outputs = model(**inputs)

>>> image_embeddings = outputs.image_embeddings
>>> text_embeddings = outputs.text_embeddings
>>> multimodal_embeddings = outputs.multimodal_embeddings

>>> outputs.image_embeddings.shape
torch.Size([1, 197, 768])

>>> text_embeddings.shape
torch.Size([1, 7, 768])

>>> multimodal_embeddings.shape
torch.Size([1, 205, 768])

get_text_features

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )

参数

  • input_ids (torch.LongTensor of shape (batch_size, text_seq_length)) — 词汇表中输入序列标记的索引。可以使用AutoTokenizer获取索引。详情请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • token_type_ids (torch.LongTensor of shape (batch_size, text_seq_length), optional) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择:
  • attention_mask (torch.FloatTensor of shape (batch_size, text_seq_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

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

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

get_image_features

< >

( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None interpolate_pos_encoding: typing.Optional[bool] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见 FlavaImageProcessor.call().
  • bool_masked_pos (torch.BoolTensor of shape (batch_size, image_num_patches)) — 布尔掩码位置。指示哪些补丁被掩码(1)和哪些没有被掩码(0)。
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • attention_mask (torch.FloatTensor of shape (batch_size, image_num_patches), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, optional) — 是否返回一个ModelOutput而不是一个普通的元组。

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

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

FlavaImageCodebook

transformers.FlavaImageCodebook

< >

( config: FlavaImageCodebookConfig **kwargs: typing.Any )

参数

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

FLAVA的图像代码本模型灵感来源于DALL-E的原始编码器。输出原始隐藏状态,并可用于基于DALL-E的词汇表生成图像的图像标记。用于生成MIM的标签。使用get_codebook_indices来获取图像的图像标记。

该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( pixel_values: FloatTensor )

get_codebook_indices

< >

( pixel_values: 张量 )

get_codebook_probs

< >

( pixel_values: 张量 )

FlavaTextModel

transformers.FlavaTextModel

< >

( config: FlavaTextConfig add_pooling_layer: bool = True )

参数

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

裸的FLAVA文本模型输出原始隐藏状态,没有任何特定的头部。 该模型是PyTorch torch.nn.Module 的子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。

前进

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, text_seq_length)) — 词汇表中输入序列标记的索引。可以使用AutoTokenizer获取索引。详情请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入 ID?
  • token_type_ids (torch.LongTensor of shape (batch_size, text_seq_length), optional) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择:
  • attention_mask (torch.FloatTensor of shape (batch_size, text_seq_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

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

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

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

  • hidden_statestuple(torch.FloatTensor)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回)— 由 torch.FloatTensor 组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回)— 由 torch.FloatTensor 组成的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlavaTextModel 的 forward 方法,重写了 __call__ 特殊方法。

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

示例:

>>> from transformers import AutoTokenizer, FlavaTextModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/flava-full")
>>> model = FlavaTextModel.from_pretrained("facebook/flava-full")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

FlavaImageModel

transformers.FlavaImageModel

< >

( config: FlavaImageConfig add_pooling_layer: bool = True )

参数

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

裸的FLAVA图像模型转换器输出原始隐藏状态,没有任何特定的头部。 该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。

前进

< >

( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None interpolate_pos_encoding: typing.Optional[bool] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见 FlavaImageProcessor.call().
  • bool_masked_pos (torch.BoolTensor of shape (batch_size, image_num_patches)) — 布尔掩码位置。指示哪些补丁被掩码(1)和哪些没有被掩码(0)。
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • attention_mask (torch.FloatTensor of shape (batch_size, image_num_patches), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

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

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

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

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

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

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

示例:

>>> from transformers import AutoImageProcessor, FlavaImageModel
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/flava-full")
>>> model = FlavaImageModel.from_pretrained("facebook/flava-full")

>>> inputs = image_processor(image, return_tensors="pt")

>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 197, 768]

FlavaMultimodalModel

transformers.FlavaMultimodalModel

< >

( config: FlavaMultimodalConfig add_pooling_layer = True )

参数

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

裸的FLAVA多模态模型转换器,输出原始隐藏状态,没有任何特定的头部。 该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。

前进

< >

( hidden_states: Tensor attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • hidden_states (torch.FloatTensor of shape (batch_size, image_num_patches + text_seq_len, hidden_size)) — 单模态编码器的连接隐藏状态。
  • attention_mask (torch.FloatTensor of shape (batch_size, image_num_patches + text_seq_len), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

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

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

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

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

FlavaMultimodalModel 的 forward 方法,重写了 __call__ 特殊方法。

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

示例:

>>> from transformers import AutoTokenizer, FlavaMultimodalModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/flava-full")
>>> model = FlavaMultimodalModel.from_pretrained("facebook/flava-full")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
< > Update on GitHub