Transformers 文档
FLAVA
并获得增强的文档体验
开始
FLAVA
概览
FLAVA 模型在 FLAVA: A Foundational Language And Vision Alignment Model 中提出，作者为 Amanpreet Singh、Ronghang Hu、Vedanuj Goswami、Guillaume Couairon、Wojciech Galuba、Marcus Rohrbach 和 Douwe Kiela，并在 CVPR 2022 上被接受。
该论文旨在创建一个单一的统一基础模型，可以跨视觉、语言以及视觉与语言多模态任务工作。
该论文的摘要如下
最先进的视觉和视觉与语言模型依赖于大规模的视觉语言预训练，以在各种下游任务上获得良好的性能。通常，这类模型通常是跨模态（对比）或多模态（具有早期融合），但并非两者兼有；而且它们通常只针对特定的模态或任务。一个有希望的方向是使用一个单一的整体通用模型，作为一个“基础”，一次性针对所有模态 —— 一个真正的视觉和语言基础模型应该擅长视觉任务、语言任务以及跨模态和多模态的视觉和语言任务。我们引入 FLAVA 作为这样一个模型，并在跨越这些目标模态的 35 个任务的广泛范围内展示了令人印象深刻的性能。
FlavaConfig
class transformers.FlavaConfig
< source >( image_config: typing.Dict[str, typing.Any] = None text_config: typing.Dict[str, typing.Any] = None multimodal_config: typing.Dict[str, typing.Any] = None image_codebook_config: typing.Dict[str, typing.Any] = None hidden_size: int = 768 layer_norm_eps: float = 1e-12 projection_dim: int = 768 init_codebook: bool = True logit_scale_init_value: float = 2.6592 initializer_range: float = 0.02 ce_ignore_index: int = -100 mim_weight: float = 1.0 mlm_weight: float = 1.0 global_contrastive_weight: float = 1.0 itm_weight: float = 1.0 mmm_image_weight: float = 1.0 mmm_text_weight: float = 1.0 global_backprop_contrastive: bool = True skip_unmasked_multimodal_encoder: bool = True return_loss: bool = True **kwargs )
参数
- text_config (
dict, 可选) — 用于初始化 FlavaTextConfig 的配置选项字典。 - image_config (
dict, 可选) — 用于初始化 FlavaImageConfig 的配置选项字典。 - multimodal_config (
dict, 可选) — 用于初始化 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 (Masked Image Modeling，掩码图像建模) 单模态损失的权重 - mlm_weight (
float, 可选, 默认为 1.0) — 分配给 MLM (Masked Language Modeling，掩码语言建模) 单模态损失的权重 - 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
< source >( image_config: FlavaImageConfig text_config: FlavaTextConfig multimodal_config: FlavaMultimodalConfig image_codebook_config: FlavaImageCodebookConfig **kwargs ) → FlavaConfig
从 flava 文本模型配置、flava 图像模型配置、flava 多模态模型和 flava 代码本模型配置实例化 FlavaConfig (或派生类)。
FlavaTextConfig
class transformers.FlavaTextConfig
< source >( 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，但对于仅文本预训练和微调，也仅使用类似于 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"的更多信息，请参阅 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 (
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) — layer normalization 层的 epsilon 值。 - image_size (
int, 可选, 默认为 224) — 每张图片的大小（分辨率）。 - patch_size (
int, 可选, 默认为 16) — 每个 patch 的大小（分辨率）。 - num_channels (
int, 可选, 默认为 3) — 输入通道数。 - qkv_bias (
bool, 可选, 默认为True) — 是否向 queries, keys 和 values 添加偏置。
这是用于存储 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
class transformers.FlavaImageConfig
< source >( 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 编码器中每个 attention 层的 attention heads 数量。 - 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) — layer normalization 层的 epsilon 值。 - image_size (
int, 可选, 默认为 224) — 每张图片的大小（分辨率）。 - patch_size (
int, 可选, 默认为 16) — 每个 patch 的大小（分辨率）。 - num_channels (
int, 可选, 默认为 3) — 输入通道数。 - qkv_bias (
bool, 可选, 默认为True) — 是否向 queries, keys 和 values 添加偏置。 - mask_token (
bool, 可选, 默认为True) — 是否使用 mask token。 用于 FLAVA 的 MIM (Masked Image Modeling) 损失。 - vocab_size (
int, 可选, 默认为 8192) — FlavaImageCodebook 的词汇表大小，与 FlavaImageModel 结合使用，用于 FLAVA 的 MIM (Masked Image Modeling) 损失。
这是用于存储 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
class transformers.FlavaMultimodalConfig
< source >( 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 (
strorfunction, 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) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon 值。 - qkv_bias (
bool, optional, defaults toTrue) — 是否向 queries、keys 和 values 添加 bias。 - use_cls_token (
bool, optional, defaults toTrue) — 是否为多模态设置使用额外的 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.configFlavaImageCodebookConfig
class transformers.FlavaImageCodebookConfig
< source >( 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
< source >( image_processor = None tokenizer = None **kwargs )
参数
- image_processor (FlavaImageProcessor, optional) — 图像处理器是必需的输入。
- tokenizer (BertTokenizerFast, optional) — 分词器是必需的输入。
构建一个 FLAVA 处理器，该处理器将 FLAVA 图像处理器和 FLAVA 分词器封装到单个处理器中。
FlavaProcessor 提供了 FlavaImageProcessor 和 BertTokenizerFast 的所有功能。有关更多信息，请参阅 __call__() 和 decode()。
此方法将其所有参数转发给 BertTokenizerFast 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。
此方法将其所有参数转发给 BertTokenizerFast 的 decode()。有关更多信息，请参阅此方法的文档字符串。
FlavaFeatureExtractor
FlavaImageProcessor
class transformers.FlavaImageProcessor
< source >( do_resize: bool = True size: typing.Dict[str, int] = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: typing.Dict[str, int] = None do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.Iterable[float], NoneType] = None image_std: typing.Union[float, typing.Iterable[float], NoneType] = None return_image_mask: bool = False input_size_patches: int = 14 total_mask_patches: int = 75 mask_group_min_patches: int = 16 mask_group_max_patches: typing.Optional[int] = None mask_group_min_aspect_ratio: float = 0.3 mask_group_max_aspect_ratio: typing.Optional[float] = None return_codebook_pixels: bool = False codebook_do_resize: bool = True codebook_size: bool = None codebook_resample: int = <Resampling.LANCZOS: 1> codebook_do_center_crop: bool = True codebook_crop_size: int = None codebook_do_rescale: bool = True codebook_rescale_factor: typing.Union[int, float] = 0.00392156862745098 codebook_do_map_pixels: bool = True codebook_do_normalize: bool = True codebook_image_mean: typing.Union[float, typing.Iterable[float], NoneType] = None codebook_image_std: typing.Union[float, typing.Iterable[float], NoneType] = None **kwargs )
参数
- do_resize (
bool, optional, defaults toTrue) — 是否将图像的（高度，宽度）尺寸调整为指定的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) — 图像在高度和宽度方向上的 patch 数量。14x14 = 总共 196 个 patch。可以被preprocess中的input_size_patches参数覆盖。 - total_mask_patches (
int, 可选，默认为 75) — 应该被掩码的 patch 总数。可以被preprocess中的total_mask_patches参数覆盖。 - mask_group_min_patches (
int, 可选，默认为 16) — 应该被掩码的最小 patch 数量。可以被preprocess中的mask_group_min_patches参数覆盖。 - mask_group_max_patches (
int, 可选) — 应该被掩码的最大 patch 数量。可以被preprocess中的mask_group_max_patches参数覆盖。 - mask_group_min_aspect_ratio (
float, 可选，默认为 0.3) — 掩码窗口的最小纵横比。可以被preprocess中的mask_group_min_aspect_ratio参数覆盖。 - mask_group_max_aspect_ratio (
float, 可选) — 掩码窗口的最大纵横比。可以被preprocess中的mask_group_max_aspect_ratio参数覆盖。 - codebook_do_resize (
bool, 可选，默认为True) — 是否调整 codebook 的输入大小。可以被preprocess中的codebook_do_resize参数和codebook_size覆盖。 - codebook_size (
Dict[str, int], 可选，默认为{"height" -- 224, "width": 224}): 调整 codebook 的输入大小为给定尺寸。可以被preprocess中的codebook_size参数覆盖。 - codebook_resample (
PILImageResampling, 可选，默认为PILImageResampling.LANCZOS) — 如果调整 codebook 图像大小，则使用的重采样滤波器。可以被preprocess中的codebook_resample参数覆盖。 - codebook_do_center_crop (
bool, 可选，默认为True) — 是否在中心裁剪 codebook 的输入。如果输入尺寸的任何一边小于codebook_crop_size，则图像将用 0 填充，然后再进行中心裁剪。可以被preprocess中的codebook_do_center_crop参数覆盖。 - codebook_crop_size (
Dict[str, int], 可选，默认为{"height" -- 224, "width": 224}): 应用中心裁剪时，codebook 输入的期望输出尺寸。可以被preprocess中的codebook_crop_size参数覆盖。 - codebook_do_rescale (
bool, 可选，默认为True) — 是否根据指定的比例codebook_rescale_factor重新缩放 codebook 的输入。可以被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 图像处理器。
preprocess
< source >( 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.Dict[str, int] = None resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[typing.Dict[str, int]] = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None return_image_mask: typing.Optional[bool] = None input_size_patches: typing.Optional[int] = None total_mask_patches: typing.Optional[int] = None mask_group_min_patches: typing.Optional[int] = None mask_group_max_patches: typing.Optional[int] = None mask_group_min_aspect_ratio: typing.Optional[float] = None mask_group_max_aspect_ratio: typing.Optional[float] = None return_codebook_pixels: typing.Optional[bool] = None codebook_do_resize: typing.Optional[bool] = None codebook_size: typing.Optional[typing.Dict[str, int]] = None codebook_resample: typing.Optional[int] = None codebook_do_center_crop: typing.Optional[bool] = None codebook_crop_size: typing.Optional[typing.Dict[str, int]] = None codebook_do_rescale: typing.Optional[bool] = None codebook_rescale_factor: typing.Optional[float] = None codebook_do_map_pixels: typing.Optional[bool] = None codebook_do_normalize: typing.Optional[bool] = None codebook_image_mean: typing.Optional[typing.Iterable[float]] = None codebook_image_std: typing.Optional[typing.Iterable[float]] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <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, 可选, 默认为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) — 从图像中提取的 patch 的大小。 - total_mask_patches (
int, 可选, 默认为self.total_mask_patches) — 从图像中提取的 patch 的总数。 - mask_group_min_patches (
int, 可选, 默认为self.mask_group_min_patches) — 从图像中提取的 patch 的最小数量。 - mask_group_max_patches (
int, 可选, 默认为self.mask_group_max_patches) — 从图像中提取的 patch 的最大数量。 - mask_group_min_aspect_ratio (
float, optional, defaults toself.mask_group_min_aspect_ratio) — 从图像中提取的patch的最小纵横比。 - mask_group_max_aspect_ratio (
float, optional, defaults toself.mask_group_max_aspect_ratio) — 从图像中提取的patch的最大纵横比。 - return_codebook_pixels (
bool, optional, defaults toself.return_codebook_pixels) — 是否返回代码本像素。 - codebook_do_resize (
bool, optional, defaults toself.codebook_do_resize) — 是否调整代码本像素的大小。 - codebook_size (
Dict[str, int], optional, defaults toself.codebook_size) — 代码本像素的大小。 - codebook_resample (
int, optional, defaults toself.codebook_resample) — 如果调整代码本像素大小，则使用的重采样过滤器。 这可以是枚举PILImageResampling之一。 仅在codebook_do_resize设置为True时有效。 - codebook_do_center_crop (
bool, optional, defaults toself.codebook_do_center_crop) — 是否对代码本像素进行中心裁剪。 - codebook_crop_size (
Dict[str, int], optional, defaults toself.codebook_crop_size) — 代码本像素的中心裁剪大小。 仅在codebook_do_center_crop设置为True时有效。 - codebook_do_rescale (
bool, optional, defaults toself.codebook_do_rescale) — 是否将代码本像素值重新缩放到 [0 - 1] 之间。 - codebook_rescale_factor (
float, optional, defaults toself.codebook_rescale_factor) — 如果codebook_do_rescale设置为True，则用于重新缩放代码本像素的重新缩放因子。 - codebook_do_map_pixels (
bool, optional, defaults toself.codebook_do_map_pixels) — 是否映射代码本像素值。 - codebook_do_normalize (
bool, optional, defaults toself.codebook_do_normalize) — 是否标准化代码本像素。 - codebook_image_mean (
floatorList[float], optional, defaults toself.codebook_image_mean) — 如果codebook_do_normalize设置为True，则用于标准化代码本像素的代码本像素均值。 - codebook_image_std (
floatorList[float], optional, defaults toself.codebook_image_std) — 如果codebook_do_normalize设置为True，则用于标准化代码本像素的代码本像素标准差。 - return_tensors (
strorTensorType, optional) — 返回张量的类型。 可以是以下之一：- Unset: 返回
np.ndarray列表。 TensorType.TENSORFLOW或'tf'：返回tf.Tensor类型的批次。TensorType.PYTORCH或'pt'：返回torch.Tensor类型的批次。TensorType.NUMPY或'np'：返回np.ndarray类型的批次。TensorType.JAX或'jax'：返回jax.numpy.ndarray类型的批次。
- Unset: 返回
- data_format (
ChannelDimensionorstr, optional, defaults toChannelDimension.FIRST) — 输出图像的通道维度格式。 可以是以下之一：ChannelDimension.FIRST: 图像格式为 (num_channels, height, width)。ChannelDimension.LAST: 图像格式为 (height, width, num_channels)。
- input_data_format (
ChannelDimensionorstr, optional) — 输入图像的通道维度格式。 如果未设置，则通道维度格式从输入图像推断。 可以是以下之一："channels_first"或ChannelDimension.FIRST: 图像格式为 (num_channels, height, width)。"channels_last"或ChannelDimension.LAST: 图像格式为 (height, width, num_channels)。"none"或ChannelDimension.NONE: 图像格式为 (height, width)。
预处理单张或批量图像。
FlavaForPreTraining
class transformers.FlavaForPreTraining
< source >( config: FlavaConfig image_codebook: typing.Optional[torch.nn.modules.module.Module] = None )
参数
- config (FlavaConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 请查看 from_pretrained() 方法来加载模型权重。
- image_codebook (
nn.Module) — 如果传入，图像代码本将设置为此项。 否则，它将首先使用配置中定义的 image_codebook_config 作为第一个参数进行初始化。
用于预训练的 FLAVA 模型，输出损失、嵌入、logits 和 Transformer 输出。
此模型是 PyTorch torch.nn.Module 子类。 可以像常规 PyTorch 模块一样使用它，并查阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None input_ids_masked: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None codebook_pixel_values: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None image_attention_mask: typing.Optional[torch.Tensor] = None skip_unmasked_multimodal_encoder: bool = None mlm_labels: typing.Optional[torch.Tensor] = None mim_labels: typing.Optional[torch.Tensor] = None itm_labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: bool = True return_dict: typing.Optional[bool] = None return_loss: typing.Optional[bool] = None ) → transformers.models.flava.modeling_flava.FlavaForPreTrainingOutput or 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)) — 布尔掩码位置。指示哪些patch被掩码（1）以及哪些没有被掩码（0）。 - interpolate_pos_encoding (
bool, 可选) — 是否插值预训练的位置编码。 - image_attention_mask (
torch.FloatTensor，形状为(batch_size, image_num_patches), 可选) — 用于避免对图像的padding token索引执行attention的掩码。掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。 什么是 attention 掩码？
- 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 表示pair不匹配，1 表示它们匹配。标签为 0 的pair也将被跳过 MMM 和全局对比损失的计算。 - return_loss (
bool, 可选, 默认为 None) — 是否返回计算出的损失。 - attention_mask (
torch.FloatTensor，形状为(batch_size, text_seq_len), 可选) — 用于避免对padding token索引执行attention的掩码。掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。 什么是 attention 掩码？
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify 自注意力模块的选定head的掩码。掩码值选自[0, 1]：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- output_attentions (
bool, 可选) — 是否返回所有attention层的attention tensor。 详见返回 tensor 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的hidden state。 详见返回 tensor 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。 - 示例 —
- ```python —
from PIL import Image import requests from transformers import FlavaForPreTraining, AutoProcessor
返回值
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 (
torch.FloatTensor，形状为(batch_size, output_dim), 可选, 当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 (
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_ids和pixel_values存在时返回) — 多模态嵌入，它基本上是 FlavaTextModel 的池化输出。 -
multimodal_masked_output (
BaseModelOutputWithPooling, 可选, 当input_ids_masked和pixel_values存在时返回) — FlavaMultimodalModel 的输出。 -
mim_logits (
torch.FloatTensor，形状为(batch_size, num_image_patches, image_vocab_size)或形状为(total_masked_patches, image_vocab_size), 可选, 当pixel_values存在且input_ids_masked不存在时返回) — MIM 单模态损失的 logits。使用book_masked_pos获取掩码的patch。当bool_masked_pos掩码了一些patch时，将返回扁平化的输出。 -
mlm_logits (
torch.FloatTensor，形状为(batch_size, text_seq_length, text_vocab_size)或形状为(total_masked_seq_length, text_vocab_size), 可选, 当input_ids_masked存在且pixel_values不存在时返回) — MLM 单模态损失的 logits。当input_ids_masked掩码了一些 token 时，将返回扁平化的输出。 -
itm_logits (
torch.FloatTensor，形状为(batch_size, 2), 可选, 当input_ids_masked和pixel_values存在时返回) — ITM 损失的 logits。请注意，ITM 损失是在 FLAVA 中的掩码pair上计算的。 -
mmm_image_logits (
torch.FloatTensor，形状为(batch_size, num_image_patches, image_vocab_size)或形状为(total_masked_patches, image_vocab_size), 可选, 当pixel_values和input_ids_masked存在时返回) — MMM 图像多模态损失的 logits。使用book_masked_pos获取掩码的patch。当bool_masked_pos掩码了一些patch时，将返回扁平化的输出。 -
mmm_text_logits (
torch.FloatTensor，形状为(batch_size, text_seq_length, text_vocab_size)或形状为((total_masked_seq_length, text_vocab_size)), *可选*, 当pixel_values和input_ids_masked存在时返回) -- MMM 文本多模态损失的 logits。当input_ids_masked` 掩码了一些 token 时，将返回扁平化的输出。 -
contrastive_logits_per_image (
torch.FloatTensor，形状为(image_batch_size, text_batch_size)) —image_embeddings和text_embeddings之间缩放的点积分数，但分别通过了 FLAVA 的image_projection和text_projection层。这表示图像-文本相似度分数。这是在未掩码的图像和文本上计算的。 -
contrastive_logits_per_text (
torch.FloatTensor，形状为(text_batch_size, image_batch_size)) —text_embeddings和image_embeddings之间缩放的点积分数，但分别通过了 FLAVA 的text_projection和image_projection层。这是在未掩码的图像和文本上计算的。
FlavaForPreTraining forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
FlavaModel
class transformers.FlavaModel
< source >( config: FlavaConfig )
参数
- config (FlavaConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
裸FLAVA模型 Transformer 输出原始 hidden-state，顶部没有任何特定的 head。 此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None image_attention_mask: typing.Optional[torch.Tensor] = None skip_multimodal_encoder: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: bool = True return_dict: typing.Optional[bool] = None ) → transformers.models.flava.modeling_flava.FlavaModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)的torch.FloatTensor) — 像素值。像素值可以使用 AutoImageProcessor 获得。 有关详细信息，请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (形状为
(batch_size, image_num_patches)的torch.BoolTensor) — 布尔掩码位置。指示哪些 patch 被掩码 (1) 以及哪些没有 (0)。 - interpolate_pos_encoding (
bool, 可选) — 是否插值预训练的位置编码。 - input_ids (形状为
(batch_size, image_num_patches + text_seq_len)的torch.LongTensor) — 输入序列 token 在词汇表中的索引。 索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 IDs？ - token_type_ids (形状为
(batch_size, image_num_patches + text_seq_len)的torch.LongTensor, 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。 什么是 token 类型 IDs？
- attention_mask (形状为
(batch_size, image_num_patches + text_seq_len)的torch.FloatTensor, 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。 什么是 attention 掩码？
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 用于 nullify self-attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 - skip_multimodal_encoder (
bool, 可选) — 跳过多模态编码器的任何计算。 如果不打算使用多模态编码，则很有用。
返回值
transformers.models.flava.modeling_flava.FlavaModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.flava.modeling_flava.FlavaModelOutput 或 torch.FloatTensor 的 tuple (如果传递了 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 (形状为
(batch_size, output_dim)的torch.FloatTensor, 可选, 当input_ids和pixel_values存在且skip_multimodal_encoder为None或False时返回) — 多模态 embeddings，它们基本上是 FlavaTextModel 的 pooled 输出。 - multimodal_output (
BaseModelOutputWithPooling, 当input_ids和pixel_values存在且skip_multimodal_encoder为None或False时返回) — FlavaMultimodalModel 的输出。
FlavaModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )
参数
- input_ids (形状为
(batch_size, text_seq_length)的torch.LongTensor) — 输入序列 token 在词汇表中的索引。 索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 IDs？ - token_type_ids (形状为
(batch_size, text_seq_length)的torch.LongTensor, 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。 什么是 token 类型 IDs？
- attention_mask (形状为
(batch_size, text_seq_length)的torch.FloatTensor, 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。 什么是 attention 掩码？
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 用于 nullify self-attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。
FlavaModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
get_image_features
< source >( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None interpolate_pos_encoding: typing.Optional[bool] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)的torch.FloatTensor) — 像素值。像素值可以使用 AutoImageProcessor 获得。 有关详细信息，请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (形状为
(batch_size, image_num_patches)的torch.BoolTensor) — 布尔掩码位置。指示哪些 patch 被掩码 (1) 以及哪些没有 (0)。 - interpolate_pos_encoding (
bool, optional) — 是否对预训练的位置编码进行插值。 - attention_mask (
torch.FloatTensor，形状为(batch_size, image_num_patches)，可选) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。 什么是 attention mask？
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定的 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
FlavaModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
FlavaImageCodebook
class transformers.FlavaImageCodebook
< source >( config: FlavaImageCodebookConfig **kwargs: typing.Any )
参数
- config (FlavaImageCodebookConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
FLAVA 的图像代码本模型灵感来自 DALL-E 的原始编码器。输出原始隐藏状态，可用于基于 DALL-E 的词汇表为图像生成图像 token。用于为 MIM 生成标签。使用 get_codebook_indices 获取图像的图像 token。
此模型是 PyTorch torch.nn.Module 子类。 可以像常规 PyTorch 模块一样使用它，并查阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
FlavaTextModel
class transformers.FlavaTextModel
< source >( config: FlavaTextConfig add_pooling_layer: bool = True )
参数
- config (FlavaTextConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 FLAVA 文本模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, text_seq_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是 input IDs？ - token_type_ids (
torch.LongTensor，形状为(batch_size, text_seq_length)，可选) — Segment token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。 什么是 token type IDs？
- attention_mask (
torch.FloatTensor，形状为(batch_size, text_seq_length)，可选) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。 什么是 attention mask？
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定的 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, optional) — 是否返回 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 (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列的第一个 token（分类 token）的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理之后。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层权重是在预训练期间从下一句预测（分类）目标中训练出来的。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlavaTextModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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
class transformers.FlavaImageModel
< source >( config: FlavaImageConfig add_pooling_layer: bool = True )
参数
- config (FlavaImageConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 FLAVA 图像模型 Transformer 输出原始隐藏状态，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)的torch.FloatTensor) — 像素值。像素值可以使用 AutoImageProcessor 获取。 有关详细信息，请参阅 FlavaImageProcessor.call()。 - bool_masked_pos (形状为
(batch_size, image_num_patches)的torch.BoolTensor) — 布尔掩码位置。指示哪些 patch 被掩码 (1) ，哪些没有 (0)。 - interpolate_pos_encoding (
bool, optional) — 是否插值预训练的位置编码。 - attention_mask (形状为
(batch_size, image_num_patches)的torch.FloatTensor, optional) — 避免对 padding token 索引执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。 什么是注意力掩码？
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, optional) — 用于 nullify 自注意力模块的选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 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 (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列的第一个 token（分类 token）的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理之后。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层权重是在预训练期间从下一句预测（分类）目标中训练出来的。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlavaImageModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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
class transformers.FlavaMultimodalModel
< source >( config: FlavaMultimodalConfig add_pooling_layer = True )
参数
- config (FlavaMultimodalConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 FLAVA 多模态模型 Transformer 输出原始隐藏状态，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- hidden_states (形状为
(batch_size, image_num_patches + text_seq_len, hidden_size)的torch.FloatTensor) — 单模态编码器的串联隐藏状态。 - attention_mask (形状为
(batch_size, image_num_patches + text_seq_len)的torch.FloatTensor, optional) — 避免对 padding token 索引执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。 什么是注意力掩码？
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, optional) — 用于 nullify 自注意力模块的选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- 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 (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列的第一个 token（分类 token）的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理之后。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层权重是在预训练期间从下一句预测（分类）目标中训练出来的。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlavaMultimodalModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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