Transformers 文件
FLAVA
並獲得增強的文件體驗
開始使用
FLAVA
概述
FLAVA 模型由 Amanpreet Singh、Ronghang Hu、Vedanuj Goswami、Guillaume Couairon、Wojciech Galuba、Marcus Rohrbach 和 Douwe Kiela 在 FLAVA: A Foundational Language And Vision Alignment Model 中提出,並被 CVPR 2022 接收。
該論文旨在建立一個單一的統一基礎模型,該模型可以跨視覺、語言以及視覺和語言多模態任務工作。
論文摘要如下:
最先進的視覺和視覺-語言模型依賴於大規模的視覺-語言預訓練,以在各種下游任務中獲得良好的效能。通常,此類模型通常是跨模態(對比)或多模態(早期融合),但不是兩者兼有;並且它們通常只針對特定的模態或任務。一個有前途的方向是使用一個單一的整體通用模型作為“基礎”,一次性針對所有模態——一個真正的視覺和語言基礎模型應該擅長視覺任務、語言任務以及跨模態和多模態視覺和語言任務。我們引入 FLAVA 作為這樣一個模型,並在涵蓋這些目標模態的 35 個任務中展示了令人印象深刻的效能。
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
從 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 (
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) — 每個 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
< 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
, 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
orfunction
, 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 toTrue
) — 是否為查詢、鍵和值新增偏差。 - mask_token (
bool
, optional, defaults toTrue
) — 是否使用掩碼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
< 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 (
str
orfunction
, 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 toTrue
) — 是否為查詢、鍵和值新增偏差。 - 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.config
FlavaImageCodebookConfig
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.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 toTrue
) — 是否將影像的(高度、寬度)尺寸調整到指定的size
。可以透過preprocess
中的do_resize
引數覆蓋。 - size (
dict[str, int]
可選, 預設為{"height" -- 224, "width": 224}
): 調整大小後圖像的大小。可以透過preprocess
中的size
引數覆蓋。 - resample (
PILImageResampling
, optional, defaults toPILImageResampling.BICUBIC
) — 如果調整影像大小,要使用的重取樣過濾器。可以透過preprocess
中的resample
引數覆蓋。 - do_center_crop (
bool
, optional, defaults toTrue
) — 是否對影像進行中心裁剪。可以透過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 toTrue
) — 是否按指定的比例rescale_factor
縮放影像。可以透過preprocess
中的do_rescale
引數覆蓋。 - rescale_factor (
int
orfloat
, optional, defaults to1/255
) — 如果縮放影像,要使用的比例因子。可以透過preprocess
中的rescale_factor
引數覆蓋。 - do_normalize (
bool
, optional, defaults toTrue
) — 是否對影像進行歸一化。可以透過preprocess
中的do_normalize
引數覆蓋。 - image_mean (
float
orlist[float]
, optional, defaults toIMAGENET_STANDARD_MEAN
) — 歸一化影像時使用的均值。這是一個浮點數或長度與影像通道數相同的浮點數列表。可以透過preprocess
方法中的image_mean
引數覆蓋。 - image_std (
float
orlist[float]
, optional, defaults toIMAGENET_STANDARD_STD
) — 歸一化影像時使用的標準差。這是一個浮點數或長度與影像通道數相同的浮點數列表。可以透過preprocess
方法中的image_std
引數覆蓋。 - return_image_mask (
bool
, optional, defaults toFalse
) — 是否返回影像掩碼。可以透過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 toTrue
) — 是否將程式碼本輸入調整到特定大小。可以透過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 toPILImageResampling.LANCZOS
) — 如果調整程式碼本影像大小,要使用的重取樣過濾器。可以透過preprocess
中的codebook_resample
引數覆蓋。 - codebook_do_center_crop (
bool
, optional, defaults toTrue
) — 是否在中心裁剪程式碼本輸入。如果輸入大小在任何邊緣小於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 toTrue
) — 是否按指定的比例codebook_rescale_factor
縮放程式碼本輸入。可以透過preprocess
中的codebook_do_rescale
引數覆蓋。 - codebook_rescale_factor (
int
orfloat
, optional, defaults to1/255
) — 定義如果縮放程式碼本影像,要使用的比例因子。可以透過preprocess
中的codebook_rescale_factor
引數覆蓋。 - codebook_do_map_pixels (
bool
, optional, defaults toTrue
) — 是否將程式碼本輸入的畫素值對映到 (1 - 2e)x + e。可以透過preprocess
中的codebook_do_map_pixels
引數覆蓋。 - codebook_do_normalize (
bool
, optional, defaults toTrue
) — 是否使用codebook_image_mean
和codebook_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 影像處理器。
預處理
< 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.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 toself.do_resize
) — 是否調整影像大小。 - size (
dict[str, int]
, optional, defaults toself.size
) — 影像的大小。 - resample (
int
, optional, defaults toself.resample
) — 如果調整影像大小,要使用的重取樣過濾器。這可以是列舉PILImageResampling
之一,僅在do_resize
設定為True
時有效。 - do_center_crop (
bool
, optional, defaults toself.do_center_crop
) — 是否對影像進行中心裁剪。 - crop_size (
dict[str, int]
, optional, defaults toself.crop_size
) — 中心裁剪的大小。僅在do_center_crop
設定為True
時有效。 - do_rescale (
bool
, optional, defaults toself.do_rescale
) — 是否將影像值縮放到 [0 - 1] 之間。 - rescale_factor (
float
, optional, defaults toself.rescale_factor
) — 如果do_rescale
設定為True
,用於縮放影像的比例因子。 - do_normalize (
bool
, optional, defaults toself.do_normalize
) — 是否對影像進行歸一化。 - image_mean (
float
orlist[float]
, optional, defaults toself.image_mean
) — 影像均值。 - image_std (
float
orlist[float]
, optional, defaults toself.image_std
) — 影像標準差。 - return_image_mask (
bool
, optional, defaults toself.return_image_mask
) — 是否返回影像掩碼。 - input_size_patches (
int
, optional, defaults toself.input_size_patches
) — 從影像中提取的補丁大小。 - total_mask_patches (
int
, optional, defaults toself.total_mask_patches
) — 從影像中提取的補丁總數。 - mask_group_min_patches (
int
, optional, defaults toself.mask_group_min_patches
) — 從影像中提取的最小補丁數量。 - mask_group_max_patches (
int
, optional, defaults toself.mask_group_max_patches
) — 從影像中提取的最大補丁數量。 - mask_group_min_aspect_ratio (
float
, optional, defaults toself.mask_group_min_aspect_ratio
) — 從影像中提取的補丁的最小長寬比。 - mask_group_max_aspect_ratio (
float
, optional, defaults toself.mask_group_max_aspect_ratio
) — 從影像中提取的補丁的最大長寬比。 - 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]
, 可選, 預設為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)。
預處理一張或一批影像。
FlavaImageProcessorFast
class transformers.FlavaImageProcessorFast
< source >( **kwargs: typing_extensions.Unpack[transformers.models.flava.image_processing_flava_fast.FlavaFastImageProcessorKwargs] )
構建一個快速的 Flava 影像處理器。
預處理
< source >( 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
< source >( 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 文件中所有與一般用法和行為相關的事項。
前向傳播
< 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: 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.FlavaForPreTrainingOutput
或 tuple(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。索引可以使用 AutoTokenizer 和DataCollatorForMaskedLanguageModeling
獲取。有關詳細資訊,請參閱 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]
:- 0 對應於 句子 A token,
- 1 對應於 句子 B token。什麼是 token type ID?
- 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]
。 - image_attention_mask (
torch.FloatTensor
, 形狀為(batch_size, image_num_patches)
, 可選) — 專門用於影像的,避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]
:- 1 表示 未被掩碼 的 token,
- 0 表示 被掩碼 的 token。什麼是注意力掩碼?
- 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.FlavaForPreTrainingOutput
或 tuple(torch.FloatTensor)
根據配置(FlavaConfig)和輸入,transformers.models.flava.modeling_flava.FlavaForPreTrainingOutput
或torch.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_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單模態損失的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_masked
和pixel_values
時返回) — ITM損失的logit。請注意,ITM損失是在FLAVA中的遮罩對上計算的。 - 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
層後的縮放點積分數。這在未遮罩的影像和文字上計算。 - 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影像多模態損失的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_values
和input_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
< source >( config: FlavaConfig )
引數
- config (FlavaConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只加載配置。請查閱from_pretrained()方法以載入模型權重。
裸Flava模型輸出原始隱藏狀態,頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等)。
此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與一般用法和行為相關的事項。
前向傳播
< 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 )
引數
- 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]
之間:- 0對應於句子A標記,
- 1對應於句子B標記。什麼是標記型別ID?
- 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]
。 - 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
< 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 ) → 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]
之間:- 0對應於句子A標記,
- 1對應於句子B標記。什麼是標記型別ID?
- position_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]
。 - 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
< 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 ) → 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
< source >( 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 文件中所有與一般用法和行為相關的事項。
FlavaTextModel
class transformers.FlavaTextModel
< source >( config: FlavaTextConfig add_pooling_layer: bool = True )
引數
- config (FlavaTextConfig) — 模型配置檔案類,包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重,只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool
, 可選, 預設為True
) — 是否新增一個池化層
Flava文字模型(輸出原始隱藏狀態,不帶任何特定頭部)。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等)。
此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與一般用法和行為相關的事項。
前向傳播
< 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 (形狀為
(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]
:- 0 對應於 句子 A token,
- 1 對應於 句子 B token。什麼是 token 型別 ID?
- position_ids (形狀為
(batch_size, sequence_length)
的torch.Tensor
, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]
。 - 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.BaseModelOutputWithPooling 或 torch.FloatTensor
的元組(如果傳入 return_dict=False
或 config.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=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
例項,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。
FlavaImageModel
class transformers.FlavaImageModel
< source >( config: FlavaImageConfig add_pooling_layer: bool = True )
引數
- config (FlavaImageConfig) — 模型配置檔案類,包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重,只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool
, 可選, 預設為True
) — 是否新增池化層
裸Flava模型輸出原始隱藏狀態,頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等)。
此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與一般用法和行為相關的事項。
前向傳播
< 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, 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.BaseModelOutputWithPooling 或 torch.FloatTensor
的元組(如果傳入 return_dict=False
或 config.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=True
或config.output_hidden_states=True
時返回) —torch.FloatTensor
的元組(如果模型有嵌入層,則包含嵌入層輸出,加上每層輸出)的形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳入output_attentions=True
或config.output_attentions=True
時返回) —torch.FloatTensor
的元組(每層一個)的形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
FlavaImageModel 的前向方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的配方需要在此函式中定義,但之後應呼叫Module
例項,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。
FlavaMultimodalModel
class transformers.FlavaMultimodalModel
< source >( config: FlavaMultimodalConfig add_pooling_layer = True )
引數
- config (FlavaMultimodalConfig) — 模型配置檔案類,包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重,只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool
, 可選, 預設為True
) — 是否新增池化層
裸Flava模型輸出原始隱藏狀態,頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等)。
此模型也是 PyTorch torch.nn.Module 子類。請將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與一般用法和行為相關的事項。
前向傳播
< 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, 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.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.BaseModelOutputWithPooling 或 torch.FloatTensor
的元組(如果傳入 return_dict=False
或 config.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=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
例項,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。