FLAVA
概述
FLAVA 模型由 Amanpreet Singh、Ronghang Hu、Vedanuj Goswami、Guillaume Couairon、Wojciech Galuba、Marcus Rohrbach 和 Douwe Kiela 在 FLAVA：基础语言和视觉对齐模型 中提出，并被 CVPR 2022 接收。
该论文旨在创建一个单一的统一基础模型，该模型可以跨视觉、语言以及视觉和语言多模态任务工作。
该论文的摘要是这样的
最先进的视觉和视觉与语言模型依靠大规模的视觉语言预训练来在各种下游任务中获得良好的性能。通常，此类模型通常是跨模态（对比）或多模态（具有较早的融合），但并非两者兼而有之；而且它们通常只针对特定的模态或任务。一个有希望的方向是使用一个单一的整体通用模型，作为“基础”，同时针对所有模态——一个真正的视觉和语言基础模型应该擅长视觉任务、语言任务以及跨模态和多模态的视觉和语言任务。我们将 FLAVA 作为这样一个模型，并在涵盖这些目标模态的 35 个任务的广泛范围内展示了令人印象深刻的性能。
FlavaConfig
类 transformers.FlavaConfig
< 源代码 >( image_config: Dict = None text_config: Dict = None multimodal_config: Dict = None image_codebook_config: Dict = 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) — 是否在对比损失中对所有 worker 使用全局反向传播。 - 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.configfrom_configs
< 源代码 >( image_config: FlavaImageConfig text_config: FlavaTextConfig multimodal_config: FlavaMultimodalConfig image_codebook_config: FlavaImageCodebookConfig **kwargs ) → 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，但对于仅限文本的预训练和微调，类似于 RoBERTa，只使用 1。 - 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"的更多信息，请参阅 具有相对位置表示的自注意力机制 (Shaw et al.)。有关"relative_key_query"的更多信息，请参阅 使用更好的相对位置嵌入改进 Transformer 模型 (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 (
str或function, 可选, 默认值为"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）— 每个补丁的大小（分辨率）。 - 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.configFlavaImageConfig
类 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, 可选，默认值为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选，默认值为 12) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, 可选，默认值为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选，默认值为 3072) — Transformer 编码器中“中间”（即，前馈）层的维度。 - hidden_act (
str或function, 可选，默认值为"gelu") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, *可选*, 默认值为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, *可选*, 默认值为 0.0) — 注意力概率的 dropout 比率。 - initializer_range (
float, *可选*, 默认值为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, *可选*, 默认值为 1e-12) — 层归一化层使用的 epsilon。 - image_size (
int, *可选*, 默认值为 224) — 每张图像的大小（分辨率）。 - patch_size (
int, *可选*, 默认值为 16) — 每个图像块的大小（分辨率）。 - num_channels (
int, *可选*, 默认值为 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.configFlavaMultimodalConfig
类 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, 可选, 默认值 768) — 编码器层和池化层维度。 - num_hidden_layers (
int, 可选, 默认值 6) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中使用的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - qkv_bias (
bool, 可选, 默认为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.configFlavaImageCodebookConfig
类 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 = None tokenizer = None **kwargs )
参数
- image_processor (FlavaImageProcessor, 可选) — 图像处理器是必需的输入。
- tokenizer (BertTokenizerFast, 可选) — 分词器是必需的输入。
构造一个 FLAVA 处理器，它将 FLAVA 图像处理器和 FLAVA 分词器包装到一个处理器中。
FlavaProcessor 提供了 FlavaImageProcessor 和 BertTokenizerFast 的所有功能。有关更多信息，请参阅 __call__() 和 decode()。
此方法会将其所有参数转发给 BertTokenizerFast 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。
此方法会将其所有参数转发给 BertTokenizerFast 的 decode()。有关更多信息，请参阅此方法的文档字符串。
FlavaFeatureExtractor
FlavaImageProcessor
class transformers.FlavaImageProcessor
< 源代码 >( do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: Dict = None do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = 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: Optional = None mask_group_min_aspect_ratio: float = 0.3 mask_group_max_aspect_ratio: Optional = None return_codebook_pixels: bool = False codebook_do_resize: bool = True codebook_size: bool = None codebook_resample: int = <Resampling.LANCZOS: 1> codebook_do_center_crop: bool = True codebook_crop_size: int = None codebook_do_rescale: bool = True codebook_rescale_factor: Union = 0.00392156862745098 codebook_do_map_pixels: bool = True codebook_do_normalize: bool = True codebook_image_mean: Union = None codebook_image_std: Union = 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 (
int或float，*可选*，默认为1/255) — 如果对图像进行缩放，则使用缩放因子。可以通过preprocess中的rescale_factor参数进行覆盖。 - do_normalize (
bool，*可选*，默认为True) — 是否对图像进行归一化。可以通过preprocess中的do_normalize参数进行覆盖。 - image_mean (
float或List[float]，*可选*，默认为IMAGENET_STANDARD_MEAN) — 如果对图像进行归一化，则使用均值。 这是一个浮点数或浮点数列表，长度为图像中的通道数。可以通过preprocess方法中的image_mean参数进行覆盖。 - image_std (
float或List[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) — 是否将代码本的输入调整到某个特定的大小。可以通过preprocess中的codebook_do_resize参数覆盖。codebook_size. - codebook_size (
Dict[str, int]，可选，默认为{"height" -- 224, "width": 224})：将代码本的输入大小调整为给定大小。可以在preprocess中使用codebook_size参数覆盖。 - codebook_resample (
PILImageResampling，可选，默认为PILImageResampling.LANCZOS) — 调整代码本图像大小使用的重采样滤镜。可以在preprocess中使用codebook_resample参数覆盖。 - codebook_do_center_crop (
bool，可选，默认为True) — 是否在中心裁剪代码本的输入。如果输入大小沿任何边缘小于codebook_crop_size，则图像将用 0 填充，然后进行中心裁剪。可以在preprocess中使用codebook_do_center_crop参数覆盖。 - codebook_crop_size (
Dict[str, int]，可选，默认为{"height" -- 224, "width": 224})：应用中心裁剪时代码本输入的所需输出大小。可以在preprocess中使用codebook_crop_size参数覆盖。 - codebook_do_rescale (
bool，可选，默认为True) — 是否按指定的比例codebook_rescale_factor重新缩放代码本的输入。可以在preprocess中使用codebook_do_rescale参数覆盖。 - codebook_rescale_factor (
int或float，可选，默认为1/255) — 定义缩放代码本图像时使用的缩放因子。可以在preprocess中使用codebook_rescale_factor参数覆盖。 - codebook_do_map_pixels (
bool，可选，默认为True) — 是否将代码本输入的像素值映射到 (1 - 2e)x + e。可以在preprocess中使用codebook_do_map_pixels参数覆盖。 - codebook_do_normalize (
bool, 可选, 默认值为True) — 是否使用codebook_image_mean和codebook_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 图像处理器。
预处理
< source >( images: Union do_resize: Optional = None size: Dict = None resample: Resampling = None do_center_crop: Optional = None crop_size: Optional = None do_rescale: Optional = None rescale_factor: Optional = None do_normalize: Optional = None image_mean: Union = None image_std: Union = None return_image_mask: Optional = None input_size_patches: Optional = None total_mask_patches: Optional = None mask_group_min_patches: Optional = None mask_group_max_patches: Optional = None mask_group_min_aspect_ratio: Optional = None mask_group_max_aspect_ratio: Optional = None return_codebook_pixels: Optional = None codebook_do_resize: Optional = None codebook_size: Optional = None codebook_resample: Optional = None codebook_do_center_crop: Optional = None codebook_crop_size: Optional = None codebook_do_rescale: Optional = None codebook_rescale_factor: Optional = None codebook_do_map_pixels: Optional = None codebook_do_normalize: Optional = None codebook_image_mean: Optional = None codebook_image_std: Optional = None return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )
参数
- images (
ImageInput) — 要预处理的图像。预期像素值范围为 0 到 255 的单张或多张图像。如果传入像素值介于 0 和 1 之间的图像，请设置do_rescale=False。 - do_resize (
bool, 可选, 默认值self.do_resize) — 是否调整图像大小。 - size (
Dict[str, int], 可选, 默认值self.size) — 图像大小。 - resample (
int, 可选, 默认为self.resample) — 如果调整图像大小，则使用重采样过滤器。这可以是枚举PILImageResampling之一，仅在do_resize设置为True时有效。 - do_center_crop (
bool, 可选, 默认为self.do_center_crop) — 是否对图像进行中心裁剪。 - crop_size (
Dict[str, int], 可选, 默认为self.crop_size) — 中心裁剪的大小。仅在do_center_crop设置为True时有效。 - do_rescale (
bool, 可选, 默认为self.do_rescale) — 是否在 [0-1] 之间重新缩放图像值。 - rescale_factor (
float, 可选, 默认为self.rescale_factor) — 如果do_rescale设置为True，则按此比例因子重新缩放图像。 - do_normalize (
bool, 可选, 默认为self.do_normalize) — 是否对图像进行标准化。 - image_mean (
float或List[float], 可选, 默认为self.image_mean) — 图像均值。 - image_std (
float或List[float], 可选, 默认为self.image_std) — 图像标准差。 - return_image_mask (
bool，可选，默认为self.return_image_mask) — 是否返回图像掩码。 - input_size_patches (
int，可选，默认为self.input_size_patches) — 要从图像中提取的补丁的大小。 - total_mask_patches (
int，可选，默认为self.total_mask_patches) — 要从图像中提取的补丁总数。 - mask_group_min_patches (
int，可选，默认为self.mask_group_min_patches) — 要从图像中提取的最小补丁数。 - mask_group_max_patches (
int，可选，默认为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，*可选*，默认为self.codebook_do_resize) — 是否调整码本像素的大小。 - codebook_size (
Dict[str, int]，*可选*，默认为self.codebook_size) — 码本像素的大小。 - codebook_resample (
int，*可选*，默认为self.codebook_resample) — 如果调整码本像素的大小，则使用重采样滤波器。这可以是枚举PILImageResampling之一，仅在codebook_do_resize设置为True时有效。 - codebook_do_center_crop (
bool，*可选*，默认为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 (
float或List[float]，可选，默认为self.codebook_image_mean) — 如果codebook_do_normalize设置为True，则用于对码本像素进行归一化的码本像素均值。 - codebook_image_std (
float或List[float]，可选，默认为self.codebook_image_std) — 如果codebook_do_normalize设置为True，则用于对码本像素进行归一化的码本像素标准差。 - return_tensors (
str或TensorType，可选) — 要返回的张量的类型。可以是以下之一：- 未设置：返回
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 (
ChannelDimension或str，可选，默认为ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：ChannelDimension.FIRST：图像采用 (num_channels, height, width) 格式。ChannelDimension.LAST：图像采用 (height, width, num_channels) 格式。
- input_data_format (
ChannelDimension或str，可选) — 输入图像的通道维度格式。如果未设置，则从输入图像推断通道维度格式。可以是以下之一："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: Optional = None )
参数
- config (FlavaConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
- image_codebook (
nn.Module) — 如果传入，则图像码本将设置为该值。 否则，它将首先使用在配置中定义的 image_codebook_config 作为第一个参数进行初始化。
用于预训练的 FLAVA 模型，输出损失、嵌入、逻辑回归和 Transformer 输出。
此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般使用和行为的所有信息。
前向
< 源代码 >( input_ids: Optional = None input_ids_masked: Optional = None pixel_values: Optional = None codebook_pixel_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None bool_masked_pos: Optional = None position_ids: Optional = None image_attention_mask: Optional = None skip_unmasked_multimodal_encoder: bool = None mlm_labels: Optional = None mim_labels: Optional = None itm_labels: Optional = None output_attentions: Optional = None output_hidden_states: bool = True return_dict: Optional = None return_loss: Optional = None ) → transformers.models.flava.modeling_flava.FlavaForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids_masked (
torch.LongTensor形状为(batch_size, text_seq_len)) — 词汇表中输入序列标记的索引。这些是与 MLM 一起使用的原始任务的掩码版本。索引可以使用 AutoTokenizer 以及DataCollatorForMaskedLanguageModeling获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 ID？ - input_ids (
torch.LongTensor形状为(batch_size, text_seq_len)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 ID？ - token_type_ids (
torch.LongTensor形状为(batch_size, text_seq_len), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。在[0, 1]中选择索引：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。 什么是标记类型 ID？
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获得。有关详细信息，请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (
torch.BoolTensor， 形状为(batch_size, image_num_patches)) — 布尔掩码位置。表示哪些图像块被掩码 (1) 和哪些没有被掩码 (0)。 - interpolate_pos_encoding (
bool, 可选) — 是否对预训练的位置编码进行插值。 - image_attention_mask (
torch.FloatTensor， 形状为(batch_size, image_num_patches), 可选) — 掩码，用于避免对图像的填充标记索引执行注意力计算。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。 什么是注意力掩码？
- 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的标记将被忽略（掩码），损失仅针对标签在[0, ..., text_config.vocab_size - 1]中的标记计算。 - mim_labels (
torch.LongTensor， 形状为(batch_size, image_num_patches), 可选) — 用于计算图像和多模态掩码建模损失的标签。索引应该在[-100, 0, ..., image_config.vocab_size - 1]中。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., image_config.vocab_size - 1]中的标记计算。 如果未传递，则使用分配给模型的图像码本自动生成。默认情况下，它使用 FlavaImageCodebook。有关如何生成 mim_labels，请参阅 FlavaImageCodebook。 - itm_labels (
torch.LongTensor， 形状为(batch_size, 1), 可选) — 用于计算图像-文本匹配损失的标签。0 表示对不匹配，1 表示匹配。值为 0 的对也将被跳过 MMM 和全局对比损失的计算。 - return_loss (
bool, 可选, 默认为 None) — 是否返回计算的损失。 - attention_mask (
torch.FloatTensor，形状为(batch_size, text_seq_len)， 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。 什么是注意力掩码？
- 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.models.flava.modeling_flava.FlavaForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.flava.modeling_flava.FlavaForPreTrainingOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (<class 'transformers.models.flava.configuration_flava.FlavaConfig'>) 和输入而定的各种元素。
-
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 (形状为
(batch_size, output_dim)的torch.FloatTensor，可选，当存在input_ids和pixel_values且skip_unmasked_multimodal_encoder为None或False时返回) — 多模态嵌入，基本上是 FlavaTextModel 的池化输出。 -
multimodal_output (
BaseModelOutputWithPooling，当存在input_ids和pixel_values且skip_unmasked_multimodal_encoder为None或False时返回) — FlavaMultimodalModel 的输出。 -
image_masked_embeddings (形状为
(batch_size, output_dim)的torch.FloatTensor，可选，当存在pixel_values时返回) — 图像嵌入，基本上是 FlavaImageModel 的池化输出。 使用bool_masked_pos创建蒙版图像。 -
image_masked_output (
BaseModelOutputWithPooling，可选，当存在pixel_values时返回) — FlavaImageModel 的输出。 使用bool_masked_pos创建蒙版图像。 -
text_masked_embeddings (形状为
(batch_size, output_dim)的torch.FloatTensor，可选，当存在input_ids_masked时返回) — 文本嵌入，基本上是 FlavaTextModel 的池化输出。 -
text_masked_output (
BaseModelOutputWithPooling，可选，当存在input_ids_masked时返回) — FlavaTextModel 的输出。 -
multimodal_masked_embeddings (形状为
(batch_size, output_dim)的torch.FloatTensor，可选，当存在input_ids和pixel_values时返回) — 多模态嵌入，基本上是 FlavaTextModel 的池化输出。 -
multimodal_masked_output (
BaseModelOutputWithPooling，可选，当存在input_ids_masked和pixel_values时返回) — FlavaMultimodalModel 的输出。 -
mim_logits (形状为
(batch_size, num_image_patches, image_vocab_size)或(total_masked_patches, image_vocab_size)的torch.FloatTensor，可选，当存在pixel_values且不存在input_ids_masked时返回) — 用于 MIM 单模态损失的 logits。 使用book_masked_pos获取蒙版补丁。 当bool_masked_pos有一些补丁被蒙版时，返回扁平化输出。 -
mlm_logits (形状为
(batch_size, text_seq_length, text_vocab_size)或(total_masked_seq_length, text_vocab_size)的torch.FloatTensor，可选，当存在input_ids_masked且不存在pixel_values时返回) — 用于 MLM 单模态损失的 logits。 当input_ids_masked有一些标记被蒙版时，返回扁平化输出。 -
itm_logits (形状为
(batch_size, 2)的torch.FloatTensor，可选，当存在input_ids_masked和pixel_values时返回) — 用于 ITM 损失的 logits。 请注意，在 FLAVA 中，ITM 损失是在蒙版对上计算的。 -
mmm_image_logits (形状为
(batch_size, num_image_patches, image_vocab_size)或(total_masked_patches, image_vocab_size)的torch.FloatTensor，可选，当存在pixel_values和input_ids_masked时返回) — 用于 MMM 图像多模态损失的 logits。 使用book_masked_pos获取蒙版补丁。 当bool_masked_pos有一些补丁被蒙版时，返回扁平化输出。 -
mmm_text_logits (形状为
(batch_size, text_seq_length, text_vocab_size)或(total_masked_seq_length, text_vocab_size)的torch.FloatTensor，可选，当存在pixel_values和input_ids_masked时返回) — 用于 MMM 文本多模态损失的 logits。 当input_ids_masked有一些标记被蒙版时，返回扁平化输出。 -
contrastive_logits_per_image (形状为
(image_batch_size, text_batch_size)的torch.FloatTensor) —image_embeddings和text_embeddings之间的缩放点积得分，但分别通过 FLAVA 的image_projection和text_projection层。 这表示图像-文本相似度得分。 这是在未蒙版的图像和文本上计算的。 -
contrastive_logits_per_text (形状为
(text_batch_size, image_batch_size)的torch.FloatTensor) —text_embeddings和image_embeddings之间的缩放点积得分，但分别通过 FLAVA 的text_projection和image_projection层。 这是在未蒙版的图像和文本上计算的。
FlavaForPreTraining 的前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方案，但之后应该调用 Module 实例而不是此实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
FlavaModel
类 transformers.FlavaModel
< 源代码 >( config: FlavaConfig )
参数
- config (FlavaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 FLAVA 模型 transformer，输出原始的隐藏状态，顶部没有任何特定的头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有信息。
前向
< source >( input_ids: Optional = None pixel_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None bool_masked_pos: Optional = None position_ids: Optional = None image_attention_mask: Optional = None skip_multimodal_encoder: Optional = None output_attentions: Optional = None output_hidden_states: bool = True return_dict: Optional = None ) → transformers.models.flava.modeling_flava.FlavaModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (
torch.BoolTensor形状为(batch_size, image_num_patches)) — 布尔掩码位置。表示哪些块被掩码 (1) 和哪些没有被掩码 (0)。 - interpolate_pos_encoding (
bool, 可选) — 是否对预训练的位置编码进行插值。 - input_ids (
torch.LongTensor， 形状为(batch_size, image_num_patches + text_seq_len)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 ID？ - token_type_ids (
torch.LongTensor， 形状为(batch_size, image_num_patches + text_seq_len)， 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。 什么是标记类型 ID？
- attention_mask (
torch.FloatTensor， 形状为(batch_size, image_num_patches + text_seq_len)， 可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 1 表示 未掩码 的标记，
- 0 表示 已掩码 的标记。 什么是注意力掩码？
- 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 而不是普通元组。 - skip_multimodal_encoder (bool, *可选*) — 跳过多模态编码器的任何计算。如果不需要使用多模态编码，则此参数很有用。
返回值
transformers.models.flava.modeling_flava.FlavaModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.flava.modeling_flava.FlavaModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (<class 'transformers.models.flava.configuration_flava.FlavaConfig'>) 和输入包含各种元素。
- 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_ids和pixel_values且skip_multimodal_encoder为None或False时返回) — 多模态嵌入，基本上是 FlavaTextModel 的池化输出。 - multimodal_output (
BaseModelOutputWithPooling，当存在input_ids和pixel_values且skip_multimodal_encoder为None或False时返回) — FlavaMultimodalModel 的输出。
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
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor，形状为(batch_size, text_seq_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.**call**()。 什么是输入 ID？ - token_type_ids (
torch.LongTensor，形状为(batch_size, text_seq_length)，*可选*) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。 什么是标记类型 ID？
- attention_mask (
torch.FloatTensor类型为(batch_size, text_seq_length), 可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值在[0, 1]中选择：- 未被掩码 的标记为 1，
- 被掩码 的标记为 0。 什么是注意力掩码？
- 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 而不是普通元组。
FlavaModel 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方案，但之后应该调用 Module 实例而不是此实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
get_image_features
< source >( pixel_values: Optional = None bool_masked_pos: Optional = None interpolate_pos_encoding: Optional = None attention_mask: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- **pixel_values** (
torch.FloatTensor类型，形状为(batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 FlavaImageProcessor.**call**()。 - **bool_masked_pos** (
torch.BoolTensor类型，形状为(batch_size, image_num_patches)) — 布尔掩码位置。指示哪些补丁被掩码 (1) 和哪些没有被掩码 (0)。 - **interpolate_pos_encoding** (
bool, 可选) — 是否对预训练的位置编码进行插值。 - **attention_mask** (
torch.FloatTensor类型，形状为(batch_size, image_num_patches), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记**未被掩码**，
- 0 表示标记**被掩码**。 什么是注意力掩码？
- **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 而不是普通元组。
FlavaModel 的 forward 方法重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方案，但之后应该调用 Module 实例而不是此实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
FlavaImageCodebook
类 transformers.FlavaImageCodebook
< source >( config: FlavaImageCodebookConfig **kwargs: Any )
参数
- config (FlavaImageCodebookConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
FLAVA 的图像码本模型灵感来自 DALL-E 的原始编码器。 输出原始隐藏状态，可用于根据 DALL-E 的词汇表生成图像的图像标记。 用于为 MIM 生成标签。 使用 get_codebook_indices 获取图像的图像标记。
此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般使用和行为的所有信息。
FlavaTextModel
类 transformers.FlavaTextModel
< 源代码 >( config: FlavaTextConfig add_pooling_layer: bool = True )
参数
- config (FlavaTextConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 FLAVA 文本模型在没有任何特定头部的情况下输出原始隐藏状态。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有内容。
前向
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor， 形状为(batch_size, text_seq_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详细信息。 什么是输入 ID？ - token_type_ids (
torch.LongTensor， 形状为(batch_size, text_seq_length)， 可选) — 用于指示输入的第一部分和第二部分的片段标记索引。在[0, 1]中选择索引：- 0 对应于 *句子 A* 标记，
- 1 对应于 *句子 B* 标记。 什么是标记类型 ID？
- attention_mask (
torch.FloatTensor， 形状为(batch_size, text_seq_length)， 可选) — 屏蔽以避免对填充标记索引执行注意力。在[0, 1]中选择屏蔽值：- 1 表示**未屏蔽**的标记，
- 0 表示**已屏蔽**的标记。 什么是注意力掩码？
- 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (FlavaTextConfig) 和输入的不同元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlavaTextModel 正向方法，重写了 __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_stateFlavaImageModel
类 transformers.FlavaImageModel
< source >( config: FlavaImageConfig add_pooling_layer: bool = True )
参数
- config (FlavaImageConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 FLAVA 图像模型，输出原始隐藏状态，顶部没有任何特定头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有信息。
前向
< source >( pixel_values: Optional = None bool_masked_pos: Optional = None interpolate_pos_encoding: Optional = None attention_mask: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。详情请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (
torch.BoolTensor，形状为(batch_size, image_num_patches)) — 布尔型掩码位置。表示哪些补丁被掩码 (1) 和哪些没有被掩码 (0)。 - interpolate_pos_encoding (
bool, 可选) — 是否对预训练的位置编码进行插值。 - attention_mask (
torch.FloatTensor，形状为(batch_size, image_num_patches), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记**未被掩码**，
- 0 表示标记**被掩码**。 什么是注意力掩码？
- 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.BaseModelOutputWithPooling 或 tuple(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 的 forward 方法，覆盖了 __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
< source >( config: FlavaMultimodalConfig add_pooling_layer = True )
参数
- config (FlavaMultimodalConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 FLAVA 多模态模型转换器，输出原始隐藏状态，顶部没有任何特定头部。该模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以获取有关一般用法和行为的所有内容。
前向
< source >( hidden_states: Tensor attention_mask: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling or tuple(torch.FloatTensor)
参数
- hidden_states (
torch.FloatTensor形状为(batch_size, image_num_patches + text_seq_len, hidden_size)) — 单模态编码器的级联隐藏状态。 - attention_mask (
torch.FloatTensor形状为(batch_size, image_num_patches + text_seq_len), 可选) — 避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。 什么是注意力掩码？
- 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.BaseModelOutputWithPooling 或 tuple(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 前向方法，覆盖了 __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