Transformers 文档

FLAVA

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

FLAVA

PyTorch

概述

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

class transformers.FlavaConfig

< >

( image_config: typing.Optional[dict[str, typing.Any]] = None text_config: typing.Optional[dict[str, typing.Any]] = None multimodal_config: typing.Optional[dict[str, typing.Any]] = None image_codebook_config: typing.Optional[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, 可选) — 用于初始化 FlavaMultimodalConfig 的配置选项字典。
  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化层维度。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。
  • projection_dim (int, 可选, 默认为 512) — 文本和图像投影层的维度。
  • logit_scale_init_value (float, 可选, 默认为 2.6592) — logit_scale 参数的初始值。默认值与原始 FLAVA/CLIP 实现相同。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • ce_ignore_index (int, 可选, 默认为 -100) — 要忽略的交叉熵索引。
  • mim_weight (float, 可选, 默认为 1.0) — 分配给 MIM(蒙版图像建模)单模态损失的权重
  • mlm_weight (float, 可选, 默认为 1.0) — 分配给 MLM(蒙版语言建模)单模态损失的权重
  • global_contrastive_weight (float, 可选, 默认为 1.0) — 分配给全局对比交叉对齐损失的权重。
  • itm_weight (float, 可选, 默认为 1.0) — 分配给图像-文本匹配多模态损失的权重。
  • mmm_image_weight (float, 可选, 默认为 1.0) — 分配给 MMM 损失的图像部分的权重。
  • mmm_text_weight (float, 可选, 默认为 1.0) — 分配给 MMM 损失的文本部分的权重。
  • global_backprop_contrastive (bool, 可选, 默认为 True) — 是否在对比损失中通过所有工作器进行全局反向传播。
  • skip_unmasked_multimodal_encoder (bool, 可选, 默认为 True) — 是否跳过运行未掩码的多模态编码器,其输出未被 FLAVA 损失使用。
  • return_loss (bool, 可选, 默认为 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

class 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 表示的不同 token 的数量。
  • type_vocab_size (int, 可选, 默认为 2) — 调用 FlavaTextModel 时传递的 token_type_ids 的词汇表大小。请注意,即使文本编码器允许 token_type_ids 的值为 2,对于仅文本的预训练和微调,仅使用 1,类似于 RoBERTa。
  • max_position_embeddings (int, 可选, 默认为 512) — 该模型可能使用的最大序列长度。通常设置为较大值以防万一(例如,512、1024 或 2048)。对于 VL,传递给模型的 max_length 为 77。
  • position_embedding_type (str, 可选, 默认为 "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.) 中的方法 4
  • 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.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。
  • image_size (int, 可选, 默认为 224) — 每张图像的大小(分辨率)。
  • patch_size (int, 可选, 默认为 16) — 每个 patch 的大小(分辨率)。
  • num_channels (int, 可选, 默认为 3) — 输入通道的数量。
  • qkv_bias (bool, 可选, 默认为 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

class 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, defaults to 768) — 编码器层和池化器层的维度。
  • num_hidden_layers (int, optional, defaults to 12) — Transformer编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 12) — Transformer编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, optional, defaults to 3072) — Transformer编码器中“中间”(即前馈)层的维度。
  • hidden_act (str or function, optional, defaults to "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, optional, defaults to 0.0) — 嵌入、编码器和池化器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, optional, defaults to 0.0) — 注意力概率的dropout比率。
  • initializer_range (float, optional, defaults to 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) — 是否为查询、键和值添加偏差。
  • mask_token (bool, optional, defaults to True) — 是否使用掩码token。在FLAVA的MIM(掩码图像建模)损失中会用到。
  • vocab_size (int, optional, defaults to 8192) — 用于与FlavaImageModel结合进行FLAVA的MIM(掩码图像建模)损失的FlavaImageCodebook的词汇表大小。

这是用于存储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

class 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, defaults to 768) — 编码器层和池化器层的维度。
  • num_hidden_layers (int, optional, defaults to 6) — Transformer编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 12) — Transformer编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, optional, defaults to 3072) — Transformer编码器中“中间”(即前馈)层的维度。
  • hidden_act (str or function, optional, defaults to "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, optional, defaults to 0.0) — 嵌入、编码器和池化器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, optional, defaults to 0.0) — 注意力概率的dropout比率。
  • initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon。
  • qkv_bias (bool, optional, defaults to True) — 是否为查询、键和值添加偏差。
  • use_cls_token (bool, optional, defaults to True) — 是否为多模态设置使用额外的CLS token。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

class 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

class transformers.FlavaProcessor

< >

( image_processor = None tokenizer = None **kwargs )

参数

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

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

batch_decode

< >

( *args **kwargs )

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

decode

< >

( *args **kwargs )

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

FlavaFeatureExtractor

class transformers.FlavaFeatureExtractor

< >

( *args **kwargs )

FlavaImageProcessor

class transformers.FlavaImageProcessor

< >

( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: typing.Optional[dict[str, int]] = None do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, collections.abc.Iterable[float], NoneType] = None image_std: typing.Union[float, collections.abc.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: typing.Optional[bool] = None codebook_resample: int = <Resampling.LANCZOS: 1> codebook_do_center_crop: bool = True codebook_crop_size: typing.Optional[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, collections.abc.Iterable[float], NoneType] = None codebook_image_std: typing.Union[float, collections.abc.Iterable[float], NoneType] = None **kwargs )

参数

  • do_resize (bool, optional, defaults to True) — 是否将图像的(高度、宽度)尺寸调整到指定的size。可以通过preprocess中的do_resize参数覆盖。
  • size (dict[str, int] 可选, 默认为 {"height" -- 224, "width": 224}): 调整大小后图像的大小。可以通过preprocess中的size参数覆盖。
  • resample (PILImageResampling, optional, defaults to PILImageResampling.BICUBIC) — 如果调整图像大小,要使用的重采样过滤器。可以通过 preprocess 中的 resample 参数覆盖。
  • do_center_crop (bool, optional, defaults to True) — 是否对图像进行中心裁剪。可以通过 preprocess 中的 do_center_crop 参数覆盖。
  • crop_size (dict[str, int] optional, defaults to {"height" -- 224, "width": 224}): 中心裁剪后图像的大小 (crop_size["height"], crop_size["width"])。可以通过 preprocess 中的 crop_size 参数覆盖。
  • do_rescale (bool, optional, defaults to True) — 是否按指定的比例 rescale_factor 缩放图像。可以通过 preprocess 中的 do_rescale 参数覆盖。
  • rescale_factor (int or float, optional, defaults to 1/255) — 如果缩放图像,要使用的比例因子。可以通过 preprocess 中的 rescale_factor 参数覆盖。
  • do_normalize (bool, optional, defaults to True) — 是否对图像进行归一化。可以通过 preprocess 中的 do_normalize 参数覆盖。
  • image_mean (float or list[float], optional, defaults to IMAGENET_STANDARD_MEAN) — 归一化图像时使用的均值。这是一个浮点数或长度与图像通道数相同的浮点数列表。可以通过 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (float or list[float], optional, defaults to IMAGENET_STANDARD_STD) — 归一化图像时使用的标准差。这是一个浮点数或长度与图像通道数相同的浮点数列表。可以通过 preprocess 方法中的 image_std 参数覆盖。
  • return_image_mask (bool, optional, defaults to False) — 是否返回图像掩码。可以通过 preprocess 中的 return_image_mask 参数覆盖。
  • input_size_patches (int, optional, defaults to 14) — 图像在高度和宽度方向上的补丁数量。14x14 = 196 个补丁。可以通过 preprocess 中的 input_size_patches 参数覆盖。
  • total_mask_patches (int, optional, defaults to 75) — 应被遮蔽的补丁总数。可以通过 preprocess 中的 total_mask_patches 参数覆盖。
  • mask_group_min_patches (int, optional, defaults to 16) — 应被遮蔽的最小补丁数量。可以通过 preprocess 中的 mask_group_min_patches 参数覆盖。
  • mask_group_max_patches (int, optional) — 应被遮蔽的最大补丁数量。可以通过 preprocess 中的 mask_group_max_patches 参数覆盖。
  • mask_group_min_aspect_ratio (float, optional, defaults to 0.3) — 遮罩窗口的最小长宽比。可以通过 preprocess 中的 mask_group_min_aspect_ratio 参数覆盖。
  • mask_group_max_aspect_ratio (float, optional) — 遮罩窗口的最大长宽比。可以通过 preprocess 中的 mask_group_max_aspect_ratio 参数覆盖。
  • codebook_do_resize (bool, optional, defaults to True) — 是否将代码本输入调整到特定大小。可以通过 preprocess 中的 codebook_do_resize 参数覆盖。 codebook_size.
  • codebook_size (dict[str, int], optional, defaults to {"height" -- 224, "width": 224}): 将代码本输入调整为给定大小。可以通过 preprocess 中的 codebook_size 参数覆盖。
  • codebook_resample (PILImageResampling, optional, defaults to PILImageResampling.LANCZOS) — 如果调整代码本图像大小,要使用的重采样过滤器。可以通过 preprocess 中的 codebook_resample 参数覆盖。
  • codebook_do_center_crop (bool, optional, defaults to True) — 是否在中心裁剪代码本输入。如果输入大小在任何边缘小于 codebook_crop_size,则图像将用 0 填充,然后进行中心裁剪。可以通过 preprocess 中的 codebook_do_center_crop 参数覆盖。
  • codebook_crop_size (dict[str, int], optional, defaults to {"height" -- 224, "width": 224}): 应用中心裁剪时代码本所需的输出大小。可以通过 preprocess 中的 codebook_crop_size 参数覆盖。
  • codebook_do_rescale (bool, optional, defaults to True) — 是否按指定的比例 codebook_rescale_factor 缩放代码本输入。可以通过 preprocess 中的 codebook_do_rescale 参数覆盖。
  • codebook_rescale_factor (int or float, optional, defaults to 1/255) — 定义如果缩放代码本图像,要使用的比例因子。可以通过 preprocess 中的 codebook_rescale_factor 参数覆盖。
  • codebook_do_map_pixels (bool, optional, defaults to True) — 是否将代码本输入的像素值映射到 (1 - 2e)x + e。可以通过 preprocess 中的 codebook_do_map_pixels 参数覆盖。
  • codebook_do_normalize (bool, optional, defaults to True) — 是否使用 codebook_image_meancodebook_image_std 对代码本输入进行归一化。可以通过 preprocess 中的 codebook_do_normalize 参数覆盖。
  • codebook_image_mean (Optional[Union[float, Iterable[float]]], optional, defaults to [0, 0, 0]) — 代码本图像归一化时每个通道的均值序列。可以通过 preprocess 方法中的 codebook_image_mean 参数覆盖。
  • codebook_image_std (Optional[Union[float, Iterable[float]]], optional, defaults to [0.5, 0.5, 0.5]) — 代码本图像归一化时每个通道的标准差序列。可以通过 preprocess 方法中的 codebook_image_std 参数覆盖。

构建 Flava 图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[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, list[float], NoneType] = None image_std: typing.Union[float, 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[dict[str, int]] = None codebook_resample: typing.Optional[int] = None codebook_do_center_crop: typing.Optional[bool] = None codebook_crop_size: typing.Optional[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[collections.abc.Iterable[float]] = None codebook_image_std: typing.Optional[collections.abc.Iterable[float]] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

参数

  • images (ImageInput) — 要预处理的图像。期望像素值范围为 0 到 255 的单张或批量图像。如果传入像素值在 0 到 1 之间的图像,请设置 do_rescale=False
  • do_resize (bool, optional, defaults to self.do_resize) — 是否调整图像大小。
  • size (dict[str, int], optional, defaults to self.size) — 图像的大小。
  • resample (int, optional, defaults to self.resample) — 如果调整图像大小,要使用的重采样过滤器。这可以是枚举 PILImageResampling 之一,仅在 do_resize 设置为 True 时有效。
  • do_center_crop (bool, optional, defaults to self.do_center_crop) — 是否对图像进行中心裁剪。
  • crop_size (dict[str, int], optional, defaults to self.crop_size) — 中心裁剪的大小。仅在 do_center_crop 设置为 True 时有效。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否将图像值缩放到 [0 - 1] 之间。
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 如果 do_rescale 设置为 True,用于缩放图像的比例因子。
  • do_normalize (bool, optional, defaults to self.do_normalize) — 是否对图像进行归一化。
  • image_mean (float or list[float], optional, defaults to self.image_mean) — 图像均值。
  • 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, optional, defaults to self.mask_group_min_aspect_ratio) — 从图像中提取的补丁的最小长宽比。
  • mask_group_max_aspect_ratio (float, optional, defaults to self.mask_group_max_aspect_ratio) — 从图像中提取的补丁的最大长宽比。
  • return_codebook_pixels (bool, optional, defaults to 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, optional, defaults to 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, 可选, 默认为 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)。

预处理一张或一批图像。

FlavaImageProcessorFast

class transformers.FlavaImageProcessorFast

< >

( **kwargs: typing_extensions.Unpack[transformers.models.flava.image_processing_flava_fast.FlavaFastImageProcessorKwargs] )

构建一个快速的 Flava 图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] **kwargs: typing_extensions.Unpack[transformers.image_processing_utils_fast.DefaultFastImageProcessorKwargs] ) <class 'transformers.image_processing_base.BatchFeature'>

参数

  • images (Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]) — 要预处理的图像。期望像素值范围在 0 到 255 之间的单张或批量图像。如果传入像素值在 0 到 1 之间的图像,请设置 do_rescale=False
  • do_resize (bool, 可选) — 是否调整图像大小。
  • size (dict[str, int], 可选) — 描述模型的最大输入维度。
  • default_to_square (bool, 可选) — 当调整图像大小时,如果 size 是一个整数,是否默认调整为正方形图像。
  • resample (Union[PILImageResampling, F.InterpolationMode, NoneType]) — 如果调整图像大小,要使用的重采样过滤器。这可以是枚举 PILImageResampling 之一。仅当 do_resize 设置为 True 时有效。
  • do_center_crop (bool, 可选) — 是否中心裁剪图像。
  • crop_size (dict[str, int], 可选) — 应用 center_crop 后输出图像的大小。
  • do_rescale (bool, 可选) — 是否重新缩放图像。
  • rescale_factor (Union[int, float, NoneType]) — 如果 do_rescale 设置为 True,则用于重新缩放图像的缩放因子。
  • do_normalize (bool, 可选) — 是否归一化图像。
  • image_mean (Union[float, list[float], NoneType]) — 用于归一化的图像平均值。仅当 do_normalize 设置为 True 时有效。
  • image_std (Union[float, list[float], NoneType]) — 用于归一化的图像标准差。仅当 do_normalize 设置为 True 时有效。
  • do_convert_rgb (bool, 可选) — 是否将图像转换为 RGB。
  • return_tensors (Union[str, ~utils.generic.TensorType, NoneType]) — 如果设置为 `pt`,则返回堆叠的张量,否则返回张量列表。
  • data_format (~image_utils.ChannelDimension, 可选) — 仅支持 ChannelDimension.FIRST。为与慢速处理器兼容而添加。
  • input_data_format (Union[str, ~image_utils.ChannelDimension, NoneType]) — 输入图像的通道维度格式。如果未设置,通道维度格式将从输入图像中推断。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。
  • device (torch.device, 可选) — 处理图像的设备。如果未设置,设备将从输入图像中推断。
  • disable_grouping (bool, 可选) — 是否禁用按大小对图像进行分组以单独而非批量处理它们。如果为 None,则如果图像在 CPU 上,则设置为 True,否则设置为 False。此选择基于经验观察,详情请参阅:https://github.com/huggingface/transformers/pull/38157

返回

<class 'transformers.image_processing_base.BatchFeature'>

  • data (dict) — 由 call 方法返回的列表/数组/张量字典(“pixel_values”等)。
  • tensor_type (Union[None, str, TensorType], 可选) — 您可以在此处提供一个`tensor_type`,以便在初始化时将整数列表转换为PyTorch/TensorFlow/Numpy张量。

FlavaForPreTraining

class transformers.FlavaForPreTraining

< >

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

参数

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

用于预训练的 FLAVA 模型,输出损失、嵌入、logits 和 Transformer 输出。

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

此模型也是 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: typing.Optional[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 (torch.LongTensor, 形状为 (batch_size, text_seq_len)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()什么是 input ID?
  • input_ids_masked (torch.LongTensor, 形状为 (batch_size, text_seq_len)) — 词汇表中输入序列 token 的索引。这些是原始任务的遮蔽版本,用于 MLM。索引可以使用 AutoTokenizerDataCollatorForMaskedLanguageModeling 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()什么是 input ID?
  • pixel_values (torch.FloatTensor, 形状为 (batch_size, num_channels, image_size, image_size), 可选) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • codebook_pixel_values (torch.FloatTensor, 形状为 (batch_size, num_image_patches, patch_size, patch_size, 3), 可选) — 用于计算遮蔽图像建模的图像码本标签的图像块的像素值。
  • attention_mask (torch.Tensor, 形状为 (batch_size, sequence_length), 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为 [0, 1]

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

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor, 形状为 (batch_size, text_seq_len), 可选) — 段落 token 索引,用于指示输入的第一部分和第二部分。索引选择范围为 [0, 1]

  • bool_masked_pos (torch.BoolTensor, 形状为 (batch_size, image_num_patches)) — 布尔遮蔽位置。指示哪些图像块被遮蔽 (1),哪些没有被遮蔽 (0)。
  • position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • image_attention_mask (torch.FloatTensor, 形状为 (batch_size, image_num_patches), 可选) — 专门用于图像的,避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为 [0, 1]

  • skip_unmasked_multimodal_encoder (*bool*, 可选) — 跳过未被遮蔽输入的任意多模态编码器计算。目前,FLAVA 预训练不需要未被遮蔽的多模态嵌入或输出。
  • mlm_labels (torch.LongTensor, 形状为 (batch_size, text_seq_len), 可选) — 用于计算从左到右语言和多模态遮蔽建模损失(下一个词预测)的标签。索引应在 [-100, 0, ..., text_config.vocab_size - 1] 之间(参见 input_ids 文档字符串)。索引设置为 -100 的 token 将被忽略(遮蔽),损失仅针对标签在 [0, ..., text_config.vocab_size - 1] 中的 token 计算。
  • mim_labels (torch.LongTensor, 形状为 (batch_size, image_num_patches), 可选) — 用于计算图像和多模态遮蔽建模损失的标签。索引应在 [-100, 0, ..., image_config.vocab_size - 1] 之间。索引设置为 -100 的 token 将被忽略(遮蔽),损失仅针对标签在 [0, ..., image_config.vocab_size - 1] 中的 token 计算。如果未传入,则使用分配给模型的图像码本自动生成。默认情况下,它使用 FlavaImageCodebook。请参阅 FlavaImageCodebook 了解如何生成 mim_labels。
  • itm_labels (torch.LongTensor,形状为(batch_size, 1)可选) — 用于计算图像-文本匹配损失的标签。0表示对不匹配,1表示对匹配。值为0的对将跳过MMM和全局对比损失的计算。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
  • output_hidden_states (bool,默认为True) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
  • return_dict (bool可选) — 是否返回ModelOutput而不是普通元组。
  • return_loss (bool可选,默认为None) — 是否返回计算的损失。

返回

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

根据配置(FlavaConfig)和输入,transformers.models.flava.modeling_flava.FlavaForPreTrainingOutputtorch.FloatTensor的元组(如果传递了return_dict=False或当config.return_dict=False时)包含各种元素。

  • loss (torch.FloatTensor可选,当return_loss为True时返回) — 为此模型计算的总损失。
  • loss_info (<class '~models.flava.modeling_flava.FlavaLosses'>.loss_info,默认为None) — 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_valuesskip_unmasked_multimodal_encoderNoneFalse时返回) — 多模态嵌入,基本上是FlavaTextModel的池化输出。
  • multimodal_output (BaseModelOutputWithPooling,当存在input_idspixel_valuesskip_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单模态损失的logit。使用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单模态损失的logit。当input_ids_masked有部分标记被遮罩时,返回扁平化的输出。
  • itm_logits (torch.FloatTensor,形状为(batch_size, 2)可选,当存在input_ids_maskedpixel_values时返回) — ITM损失的logit。请注意,ITM损失是在FLAVA中的遮罩对上计算的。
  • 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层后的缩放点积分数。这在未遮罩的图像和文本上计算。
  • mmm_image_logits (torch.FloatTensor,形状为(batch_size, num_image_patches, image_vocab_size)(total_masked_patches, image_vocab_size)可选,当存在pixel_valuesinput_ids_masked时返回) — MMM图像多模态损失的logit。使用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文本多模态损失的logit。当input_ids_masked有部分标记被遮罩时,返回扁平化的输出。

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

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

示例

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

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

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

>>> text = ["a photo of a cat"]

>>> inputs = processor(
...     images=[image],
...     text=text,
...     return_masks=True,
...     return_codebook_pixels=True,
...     padding=True,
...     max_length=77,
...     return_tensors="pt",
... )


>>> output = model(**inputs)

FlavaModel

class transformers.FlavaModel

< >

( config: FlavaConfig )

参数

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

裸Flava模型输出原始隐藏状态,顶部没有任何特定头部。

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

此模型也是 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 )

参数

  • input_ids (torch.LongTensor,形状为(batch_size, image_num_patches + text_seq_len)) — 词汇表中输入序列标记的索引。索引可以使用AutoTokenizer获取。详细信息请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • pixel_values (torch.FloatTensor,形状为(batch_size, num_channels, image_size, image_size)可选) — 对应于输入图像的张量。像素值可以使用{image_processor_class}获取。详细信息请参阅{image_processor_class}.__call__{processor_class}使用{image_processor_class}处理图像)。
  • attention_mask (torch.Tensor,形状为(batch_size, sequence_length)可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为(batch_size, image_num_patches + text_seq_len)可选) — 分段标记索引,用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间:

  • bool_masked_pos (torch.BoolTensor,形状为(batch_size, image_num_patches)) — 布尔遮罩位置。指示哪些块被遮罩(1)哪些没有被遮罩(0)。
  • position_ids (torch.LongTensor,形状为(batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]

    什么是位置ID?

  • image_attention_mask (torch.Tensor,形状为(batch_size, image_num_patches)可选) — 避免对图像输入的填充像素值执行注意力的掩码。掩码值选择在[0, 1]之间:

    • 1表示真实的像素值(即未被遮罩),
    • 0表示填充的像素值(即被遮罩)。
  • skip_multimodal_encoder (*bool*可选) — 跳过多模态编码器的任何计算。如果不需要使用多模态编码,则非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
  • output_hidden_states (bool,默认为True) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
  • return_dict (bool可选) — 是否返回ModelOutput而不是普通元组。

FlavaModel的forward方法,重写了__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 ) text_features (torch.FloatTensor,形状为(batch_size, output_dim)

参数

  • input_ids (torch.LongTensor,形状为(batch_size, text_seq_length)) — 词汇表中输入序列标记的索引。索引可以使用AutoTokenizer获取。详细信息请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入ID?
  • attention_mask (torch.Tensor,形状为(batch_size, sequence_length)可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为(batch_size, text_seq_length)可选) — 分段标记索引,用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间:

  • position_ids (torch.Tensor,形状为(batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]

    什么是位置ID?

  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
  • return_dict (bool可选) — 是否返回ModelOutput而不是普通元组。

返回

text_features (torch.FloatTensor, 形状为 (batch_size, output_dim)

通过将投影层应用于FlavaTextModel的池化输出获得的文本嵌入。

示例

>>> from transformers import AutoProcessor, FlavaModel

>>> model = FlavaModel.from_pretrained("{0}")
>>> processor = AutoProcessor.from_pretrained("{0}")

>>> inputs = processor(
...     text=["a photo of a cat", "a photo of a dog"], max_length=77, padding="max_length", return_tensors="pt"
... )
>>> text_features = model.get_text_features(**inputs)

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 ) image_features (torch.FloatTensor,形状为(batch_size, output_dim)

参数

  • pixel_values (torch.Tensor,形状为(batch_size, num_channels, image_size, image_size)可选) — 对应于输入图像的张量。像素值可以使用{image_processor_class}获取。详细信息请参阅{image_processor_class}.__call__{processor_class}使用{image_processor_class}处理图像)。
  • bool_masked_pos (torch.BoolTensor,形状为(batch_size, image_num_patches)) — 布尔遮罩位置。指示哪些块被遮罩(1)哪些没有被遮罩(0)。
  • interpolate_pos_encoding (bool可选) — 是否对预训练的位置编码进行插值。
  • attention_mask (torch.Tensor,形状为(batch_size, sequence_length)可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力掩码?

  • head_mask (torch.Tensor,形状为(num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间:

    • 1表示头部未被遮罩
    • 0表示头部被遮罩
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
  • return_dict (bool可选) — 是否返回ModelOutput而不是普通元组。

返回

image_features (torch.FloatTensor, 形状为 (batch_size, output_dim)

通过将投影层应用于FlavaImageModel的池化输出获得的图像嵌入。

示例

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

>>> model = FlavaModel.from_pretrained("{0}")
>>> processor = AutoProcessor.from_pretrained("{0}")

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

>>> inputs = processor(images=image, return_tensors="pt")

>>> image_features = model.get_image_features(**inputs)

FlavaImageCodebook

class transformers.FlavaImageCodebook

< >

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

参数

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

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

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

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

前向传播

< >

( pixel_values: FloatTensor )

get_codebook_indices

< >

( pixel_values: Tensor )

get_codebook_probs

< >

( pixel_values: Tensor )

FlavaTextModel

class transformers.FlavaTextModel

< >

( config: FlavaTextConfig add_pooling_layer: bool = True )

参数

  • config (FlavaTextConfig) — 模型配置文件类,包含模型的所有参数。使用配置文件初始化模型不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
  • add_pooling_layer (bool, 可选, 默认为 True) — 是否添加一个池化层

Flava文本模型(输出原始隐藏状态,不带任何特定头部)。

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

此模型也是 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 (形状为 (batch_size, text_seq_length)torch.LongTensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入 ID?
  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是注意力掩码?

  • token_type_ids (形状为 (batch_size, text_seq_length)torch.LongTensor, 可选) — 用于指示输入的第一部分和第二部分的段 token 索引。索引选择范围为 [0, 1]

  • position_ids (形状为 (batch_size, sequence_length)torch.Tensor, 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.Tensor, 可选) — 用于置空自注意力模块选定头部的掩码。掩码值选择范围为 [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.BaseModelOutputWithPoolingtorch.FloatTensor 的元组(如果传入 return_dict=Falseconfig.return_dict=False)包含根据配置(FlavaConfig)和输入的不同元素。

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

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

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

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

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

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

FlavaTextModel 的前向方法,覆盖了 __call__ 特殊方法。

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

FlavaImageModel

class transformers.FlavaImageModel

< >

( config: FlavaImageConfig add_pooling_layer: bool = True )

参数

  • config (FlavaImageConfig) — 模型配置文件类,包含模型的所有参数。使用配置文件初始化模型不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
  • add_pooling_layer (bool, 可选, 默认为 True) — 是否添加池化层

裸Flava模型输出原始隐藏状态,顶部没有任何特定头部。

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

此模型也是 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 (形状为 (batch_size, num_channels, image_size, image_size)torch.Tensor, 可选) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • bool_masked_pos (形状为 (batch_size, image_num_patches)torch.BoolTensor) — 布尔掩码位置。指示哪些 patch 被掩盖 (1) 哪些没有 (0)。
  • interpolate_pos_encoding (bool, 可选) — 是否插值预训练的位置编码。
  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是注意力掩码?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.Tensor, 可选) — 用于置空自注意力模块选定头部的掩码。掩码值选择范围为 [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.BaseModelOutputWithPoolingtorch.FloatTensor 的元组(如果传入 return_dict=Falseconfig.return_dict=False)包含根据配置(FlavaConfig)和输入的不同元素。

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

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

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

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

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

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

FlavaImageModel 的前向方法,覆盖了 __call__ 特殊方法。

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

FlavaMultimodalModel

class transformers.FlavaMultimodalModel

< >

( config: FlavaMultimodalConfig add_pooling_layer = True )

参数

  • config (FlavaMultimodalConfig) — 模型配置文件类,包含模型的所有参数。使用配置文件初始化模型不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
  • add_pooling_layer (bool, 可选, 默认为 True) — 是否添加池化层

裸Flava模型输出原始隐藏状态,顶部没有任何特定头部。

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

此模型也是 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 (形状为 (batch_size, image_num_patches + text_seq_len, hidden_size)torch.FloatTensor) — 单模态编码器连接后的隐藏状态。
  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是注意力掩码?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.Tensor, 可选) — 用于置空自注意力模块选定头部的掩码。掩码值选择范围为 [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.BaseModelOutputWithPoolingtorch.FloatTensor 的元组(如果传入 return_dict=Falseconfig.return_dict=False)包含根据配置(FlavaConfig)和输入的不同元素。

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

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

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

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

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

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

FlavaMultimodalModel 的前向方法,覆盖了 __call__ 特殊方法。

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

< > 在 GitHub 上更新