Transformers 文件
ALIGN
並獲得增強的文件體驗
開始使用
ALIGN
ALIGN 在一個包含18億噪聲文字-影像對的資料集上進行預訓練,以證明規模可以彌補噪聲。它採用雙編碼器架構,即用於影像的 EfficientNet 和用於文字的 BERT,並使用對比損失將相似的影像-文字嵌入對齊,同時將不同的嵌入推開。經過訓練後,ALIGN 可以將任何影像和候選標題編碼到共享向量空間中,用於零樣本檢索或分類,而無需額外標籤。這種規模優先的方法降低了資料集整理成本,併為最先進的影像-文字檢索和零樣本 ImageNet 分類提供了支援。
您可以在 Kakao Brain 組織下找到所有原始 ALIGN 檢查點。
點選右側邊欄中的 ALIGN 模型,檢視更多關於如何將 ALIGN 應用於不同視覺和文字相關任務的示例。
以下示例演示了使用 Pipeline 或 AutoModel 類進行零樣本影像分類。
import torch
from transformers import pipeline
pipeline = pipeline(
task="zero-shot-image-classification",
model="kakaobrain/align-base",
device=0,
torch_dtype=torch.bfloat16
)
candidate_labels = [
"a photo of a dog",
"a photo of a cat",
"a photo of a person"
]
pipeline("https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg", candidate_labels=candidate_labels)
注意事項
ALIGN 將文字和視覺特徵投影到潛在空間中,投影后的影像和文字特徵之間的點積用作相似度分數。以下示例演示瞭如何使用 AlignProcessor 和 AlignModel 計算影像-文字相似度分數。
# Example of using ALIGN for image-text similarity from transformers import AlignProcessor, AlignModel import torch from PIL import Image import requests from io import BytesIO # Load processor and model processor = AlignProcessor.from_pretrained("kakaobrain/align-base") model = AlignModel.from_pretrained("kakaobrain/align-base") # Download image from URL url = "https://huggingface.co/roschmid/dog-races/resolve/main/images/Golden_Retriever.jpg" response = requests.get(url) image = Image.open(BytesIO(response.content)) # Convert the downloaded bytes to a PIL Image texts = ["a photo of a cat", "a photo of a dog"] # Process image and text inputs inputs = processor(images=image, text=texts, return_tensors="pt") # Get the embeddings with torch.no_grad(): outputs = model(**inputs) image_embeds = outputs.image_embeds text_embeds = outputs.text_embeds # Normalize embeddings for cosine similarity image_embeds = image_embeds / image_embeds.norm(dim=1, keepdim=True) text_embeds = text_embeds / text_embeds.norm(dim=1, keepdim=True) # Calculate similarity scores similarity_scores = torch.matmul(text_embeds, image_embeds.T) # Print raw scores print("Similarity scores:", similarity_scores) # Convert to probabilities probs = torch.nn.functional.softmax(similarity_scores, dim=0) print("Probabilities:", probs) # Get the most similar text most_similar_idx = similarity_scores.argmax().item() print(f"Most similar text: '{texts[most_similar_idx]}'")
資源
- 有關更多詳細資訊,請參閱 Kakao Brain 的開源 ViT、ALIGN 和新的 COYO 文字-影像資料集 部落格文章。
AlignConfig
class transformers.AlignConfig
< 源 >( text_config = None vision_config = None projection_dim = 640 temperature_init_value = 1.0 initializer_range = 0.02 **kwargs )
引數
- text_config (
dict
, 可選) — 用於初始化 AlignTextConfig 的配置選項字典。 - vision_config (
dict
, 可選) — 用於初始化 AlignVisionConfig 的配置選項字典。 - projection_dim (
int
, 可選, 預設為 640) — 文字和視覺投影層的維度。 - temperature_init_value (
float
, 可選, 預設為 1.0) — *溫度* 引數的初始值。預設值與原始 ALIGN 實現中的一致。 - initializer_range (
float
, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - kwargs (可選) — 關鍵字引數字典。
AlignConfig 是用於儲存 AlignModel 配置的配置類。它用於根據指定的引數例項化 ALIGN 模型,定義文字模型和視覺模型配置。使用預設值例項化配置將生成與 ALIGN kakaobrain/align-base 架構類似的配置。
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。有關更多資訊,請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import AlignConfig, AlignModel
>>> # Initializing a AlignConfig with kakaobrain/align-base style configuration
>>> configuration = AlignConfig()
>>> # Initializing a AlignModel (with random weights) from the kakaobrain/align-base style configuration
>>> model = AlignModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
>>> # We can also initialize a AlignConfig from a AlignTextConfig and a AlignVisionConfig
>>> from transformers import AlignTextConfig, AlignVisionConfig
>>> # Initializing ALIGN Text and Vision configurations
>>> config_text = AlignTextConfig()
>>> config_vision = AlignVisionConfig()
>>> config = AlignConfig.from_text_vision_configs(config_text, config_vision)
from_text_vision_configs
< 源 >( text_config: AlignTextConfig vision_config: AlignVisionConfig **kwargs ) → AlignConfig
從 Align 文字模型配置和 Align 視覺模型配置例項化 AlignConfig (或其派生類)。
AlignTextConfig
class transformers.AlignTextConfig
< 源 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True **kwargs )
引數
- vocab_size (
int
, 可選, 預設為 30522) — Align 文字模型的詞彙表大小。定義了呼叫 AlignTextModel 時傳入的inputs_ids
可以表示的不同詞符的數量。 - hidden_size (
int
, 可選, 預設為 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int
, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int
, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int
, 可選, 預設為 3072) — Transformer 編碼器中“中間”(通常稱為前饋)層的維度。 - hidden_act (
str
或Callable
, 可選, 預設為"gelu"
) — 編碼器和池化器中的非線性啟用函式(函式或字串)。如果是字串,支援"gelu"
,"relu"
,"silu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可選, 預設為 0.1) — 嵌入、編碼器和池化器中所有全連線層的丟棄機率。 - attention_probs_dropout_prob (
float
, 可選, 預設為 0.1) — 注意力機率的丟棄比率。 - max_position_embeddings (
int
, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常設定為較大值以防萬一(例如,512、1024 或 2048)。 - type_vocab_size (
int
, 可選, 預設為 2) — 呼叫 AlignTextModel 時傳入的token_type_ids
的詞彙表大小。 - initializer_range (
float
, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float
, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon。 - pad_token_id (
int
, 可選, 預設為 0) — 填充詞符 ID。 - 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*。 - use_cache (
bool
, 可選, 預設為True
) — 模型是否應返回最後的鍵/值注意力(並非所有模型都使用)。僅當config.is_decoder=True
時相關。
這是用於儲存 AlignTextModel 配置的配置類。它用於根據指定的引數例項化 ALIGN 文字編碼器,定義模型架構。使用預設值例項化配置將生成與 ALIGN kakaobrain/align-base 架構的文字編碼器類似的配置。這裡的預設值複製自 BERT。
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。有關更多資訊,請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import AlignTextConfig, AlignTextModel
>>> # Initializing a AlignTextConfig with kakaobrain/align-base style configuration
>>> configuration = AlignTextConfig()
>>> # Initializing a AlignTextModel (with random weights) from the kakaobrain/align-base style configuration
>>> model = AlignTextModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
AlignVisionConfig
class transformers.AlignVisionConfig
< 源 >( num_channels: int = 3 image_size: int = 600 width_coefficient: float = 2.0 depth_coefficient: float = 3.1 depth_divisor: int = 8 kernel_sizes: list = [3, 3, 5, 3, 5, 5, 3] in_channels: list = [32, 16, 24, 40, 80, 112, 192] out_channels: list = [16, 24, 40, 80, 112, 192, 320] depthwise_padding: list = [] strides: list = [1, 2, 2, 2, 1, 2, 1] num_block_repeats: list = [1, 2, 2, 3, 3, 4, 1] expand_ratios: list = [1, 6, 6, 6, 6, 6, 6] squeeze_expansion_ratio: float = 0.25 hidden_act: str = 'swish' hidden_dim: int = 2560 pooling_type: str = 'mean' initializer_range: float = 0.02 batch_norm_eps: float = 0.001 batch_norm_momentum: float = 0.99 drop_connect_rate: float = 0.2 **kwargs )
引數
- num_channels (
int
, 可選, 預設為 3) — 輸入通道的數量。 - image_size (
int
, 可選, 預設為 600) — 輸入影像大小。 - width_coefficient (
float
, 可選, 預設為 2.0) — 每個階段網路寬度的縮放係數。 - depth_coefficient (
float
, 可選, 預設為 3.1) — 每個階段網路深度的縮放係數。 - depth_divisor
int
, 可選, 預設為 8) — 網路寬度的單位。 - kernel_sizes (
list[int]
, 可選, 預設為[3, 3, 5, 3, 5, 5, 3]
) — 每個塊中使用的核大小列表。 - in_channels (
list[int]
, 可選, 預設為[32, 16, 24, 40, 80, 112, 192]
) — 卷積層在每個塊中使用的輸入通道大小列表。 - out_channels (
list[int]
, 可選, 預設為[16, 24, 40, 80, 112, 192, 320]
) — 卷積層在每個塊中使用的輸出通道大小列表。 - depthwise_padding (
list[int]
, 可選, 預設為[]
) — 帶有方形填充的塊索引列表。 - strides (
list[int]
, 可選, 預設為[1, 2, 2, 2, 1, 2, 1]
) — 卷積層在每個塊中使用的步幅大小列表。 - num_block_repeats (
list[int]
, 可選, 預設為[1, 2, 2, 3, 3, 4, 1]
) — 每個塊重複的次數列表。 - expand_ratios (
list[int]
, 可選, 預設為[1, 6, 6, 6, 6, 6, 6]
) — 每個塊的縮放係數列表。 - squeeze_expansion_ratio (
float
, 可選, 預設為 0.25) — 壓縮擴充套件比。 - hidden_act (
str
或function
, 可選, 預設為"silu"
) — 每個塊中的非線性啟用函式(函式或字串)。如果為字串,支援"gelu"
,"relu"
,"selu"
,"gelu_new"
,"silu"
和"mish"
。 - hidden_dim (
int
, 可選, 預設為 1280) — 分類頭之前的層的隱藏維度。 - pooling_type (
str
或function
, 可選, 預設為"mean"
) — 在密集分類頭之前應用的最終池化型別。可用選項為 [`"mean"`, `"max"`]。 - initializer_range (
float
, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - batch_norm_eps (
float
, 可選, 預設為 1e-3) — 批次歸一化層使用的 epsilon。 - batch_norm_momentum (
float
, 可選, 預設為 0.99) — 批次歸一化層使用的動量。 - drop_connect_rate (
float
, 可選, 預設為 0.2) — 跳過連線的丟棄率。
這是一個配置類,用於儲存 AlignVisionModel 的配置。它用於根據指定的引數例項化 ALIGN 視覺編碼器,定義模型架構。使用預設值例項化配置將生成與 ALIGN kakaobrain/align-base 架構的視覺編碼器類似的配置。預設值複製自 EfficientNet (efficientnet-b7)
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。有關更多資訊,請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import AlignVisionConfig, AlignVisionModel
>>> # Initializing a AlignVisionConfig with kakaobrain/align-base style configuration
>>> configuration = AlignVisionConfig()
>>> # Initializing a AlignVisionModel (with random weights) from the kakaobrain/align-base style configuration
>>> model = AlignVisionModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
AlignProcessor
class transformers.AlignProcessor
< 來源 >( image_processor tokenizer )
引數
- image_processor (EfficientNetImageProcessor) — 影像處理器是必需的輸入。
- tokenizer ([
BertTokenizer
,BertTokenizerFast
]) — 分詞器是必需的輸入。
構建一個 ALIGN 處理器,它將 EfficientNetImageProcessor 和 BertTokenizer/BertTokenizerFast 封裝成一個單一的處理器,該處理器繼承了影像處理器和分詞器功能。有關更多資訊,請參閱 __call__()
和 decode()
。傳遞 kwargs 的首選方式是每個模態一個字典,請參閱下面的用法示例。
from transformers import AlignProcessor
from PIL import Image
model_id = "kakaobrain/align-base"
processor = AlignProcessor.from_pretrained(model_id)
processor(
images=your_pil_image,
text=["What is that?"],
images_kwargs = {"crop_size": {"height": 224, "width": 224}},
text_kwargs = {"padding": "do_not_pad"},
common_kwargs = {"return_tensors": "pt"},
)
此方法將其所有引數轉發至 BertTokenizerFast 的 batch_decode()。有關更多資訊,請參閱此方法的文件字串。
AlignModel
class transformers.AlignModel
< 來源 >( config: AlignConfig )
引數
- config (AlignConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重,只會載入配置。要載入模型權重,請檢視 from_pretrained() 方法。
裸 Align 模型,輸出原始隱藏狀態,頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組,並參考 PyTorch 文件中有關一般用法和行為的所有內容。
forward
< 來源 >( 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 position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None return_loss: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.align.modeling_align.AlignOutput
或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor
形狀為(batch_size, sequence_length)
, 可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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)
, 可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示 token 未被掩蓋,
- 0 表示 token 已被掩蓋。
- token_type_ids (
torch.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 段落 token 索引,用於指示輸入的第一個和第二個部分。索引在[0, 1]
中選擇:- 0 對應於 句子 A token,
- 1 對應於 句子 B token。
- position_ids (
torch.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]
範圍內選擇。 - head_mask (
torch.Tensor
形狀為(num_heads,)
或(num_layers, num_heads)
, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示頭部未被掩蓋,
- 0 表示頭部已被掩蓋。
- inputs_embeds (
torch.Tensor
形狀為(batch_size, sequence_length, hidden_size)
, 可選) — 可選地,你可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果你想對如何將input_ids
索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制,這很有用。 - return_loss (
bool
, 可選) — 是否返回對比損失。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回 ModelOutput 而不是純元組。
返回
transformers.models.align.modeling_align.AlignOutput
或 tuple(torch.FloatTensor)
一個 transformers.models.align.modeling_align.AlignOutput
或一個 torch.FloatTensor
元組(如果傳遞 return_dict=False
或 config.return_dict=False
時),包含根據配置(AlignConfig)和輸入的不同元素。
- loss (
torch.FloatTensor
,形狀為(1,)
, 可選, 當return_loss
為True
時返回) — 影像-文字相似度的對比損失。 - logits_per_image (
torch.FloatTensor
形狀為(image_batch_size, text_batch_size)
) —image_embeds
和text_embeds
之間的縮放點積分數。這表示影像-文字相似性分數。 - logits_per_text (
torch.FloatTensor
形狀為(text_batch_size, image_batch_size)
) —text_embeds
和image_embeds
之間的縮放點積分數。這表示文字-影像相似性分數。 - text_embeds (
torch.FloatTensor
形狀為(batch_size, output_dim
) — 透過將投影層應用於 AlignTextModel 的池化輸出而獲得的文字嵌入。 - image_embeds (
torch.FloatTensor
形狀為(batch_size, output_dim
) — AlignVisionModel 的輸出。 - text_model_output (
<class '~modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions'>.text_model_output
, 預設為None
) — AlignTextModel 的輸出。 - vision_model_output (
<class '~modeling_outputs.BaseModelOutputWithPoolingAndNoAttention'>.vision_model_output
, 預設為None
) — AlignVisionModel 的輸出。
AlignModel 的前向方法,覆蓋了 __call__
特殊方法。
雖然前向傳播的配方需要在該函式中定義,但此後應呼叫 Module
例項,而不是此函式,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。
示例
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, AlignModel
>>> model = AlignModel.from_pretrained("kakaobrain/align-base")
>>> processor = AutoProcessor.from_pretrained("kakaobrain/align-base")
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> inputs = processor(
... images=image, text=["a photo of a cat", "a photo of a dog"], return_tensors="pt", padding=True
... )
>>> outputs = model(**inputs)
>>> logits_per_image = outputs.logits_per_image # this is the image-text similarity score
>>> probs = logits_per_image.softmax(dim=1) # we can take the softmax to get the label probabilities
get_text_features
< 來源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: 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.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示 token 未被掩蓋,
- 0 表示 token 已被掩蓋。
- token_type_ids (
torch.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 段落 token 索引,用於指示輸入的第一個和第二個部分。索引在[0, 1]
中選擇:- 0 對應於 句子 A token,
- 1 對應於 句子 B token。
- position_ids (
torch.Tensor
形狀為(batch_size, sequence_length)
, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]
範圍內選擇。 - head_mask (
torch.Tensor
形狀為(num_heads,)
或(num_layers, num_heads)
, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示頭部未被掩蓋,
- 0 表示頭部已被掩蓋。
- inputs_embeds (
torch.Tensor
形狀為(batch_size, sequence_length, hidden_size)
, 可選) — 可選地,你可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果你想對如何將input_ids
索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制,這很有用。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
, optional) — 是否返回一個 ModelOutput 物件而不是一個普通元組。
返回
text_features (torch.FloatTensor
, 形狀為 (batch_size, output_dim
)
透過將投影層應用於 AlignTextModel 的池化輸出而獲得的文字嵌入。
示例
>>> from transformers import AutoTokenizer, AlignModel
>>> model = AlignModel.from_pretrained("kakaobrain/align-base")
>>> tokenizer = AutoTokenizer.from_pretrained("kakaobrain/align-base")
>>> inputs = tokenizer(["a photo of a cat", "a photo of a dog"], padding=True, return_tensors="pt")
>>> text_features = model.get_text_features(**inputs)
get_image_features
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → image_features (torch.FloatTensor
of shape (batch_size, output_dim
)
引數
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, image_size, image_size)
, optional) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}
獲取。有關詳細資訊,請參見{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
處理影像)。 - output_hidden_states (
bool
, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量中的hidden_states
。 - return_dict (
bool
, optional) — 是否返回一個 ModelOutput 物件而不是一個普通元組。
返回
image_features (torch.FloatTensor
, 形狀為 (batch_size, output_dim
)
透過將投影層應用於 AlignVisionModel 的池化輸出而獲得的影像嵌入。
示例
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, AlignModel
>>> model = AlignModel.from_pretrained("kakaobrain/align-base")
>>> processor = AutoProcessor.from_pretrained("kakaobrain/align-base")
>>> 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)
AlignTextModel
class transformers.AlignTextModel
< source >( config: AlignTextConfig add_pooling_layer: bool = True )
引數
- config (AlignTextConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,僅載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool
, optional, 預設為True
) — 是否新增池化層
沒有頭部或投影層的 ALIGN 文字模型。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
此模型也是 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 inputs_embeds: 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.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
of shape(batch_size, sequence_length)
, optional) — 輸入序列標記在詞彙表中的索引。預設情況下將忽略填充。索引可以使用 AutoTokenizer 獲取。有關詳細資訊,請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
of shape(batch_size, sequence_length)
, optional) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]
之間:- 1 表示未被掩蓋的標記,
- 0 表示被掩蓋的標記。
- token_type_ids (
torch.Tensor
of shape(batch_size, sequence_length)
, optional) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]
之間:- 0 對應於*句子 A* 標記,
- 1 對應於*句子 B* 標記。
- position_ids (
torch.Tensor
of shape(batch_size, sequence_length)
, optional) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
of shape(num_heads,)
or(num_layers, num_heads)
, optional) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]
之間:- 1 表示頭部未被掩蓋,
- 0 表示頭部被掩蓋。
- inputs_embeds (
torch.Tensor
of shape(batch_size, sequence_length, hidden_size)
, optional) — 可選地,除了傳遞input_ids
之外,您還可以選擇直接傳遞嵌入表示。如果您希望對如何將input_ids
索引轉換為關聯向量(而不是模型的內部嵌入查詢矩陣)有更多控制,這會很有用。 - output_attentions (
bool
, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量中的attentions
。 - output_hidden_states (
bool
, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量中的hidden_states
。 - return_dict (
bool
, optional) — 是否返回一個 ModelOutput 物件而不是一個普通元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor
元組(如果傳遞 return_dict=False
或當 config.return_dict=False
時),包含根據配置 (AlignConfig) 和輸入的不同元素。
-
last_hidden_state (
torch.FloatTensor
, 形狀為(batch_size, sequence_length, hidden_size)
) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
torch.FloatTensor
of shape(batch_size, hidden_size)
) — 序列中第一個標記(分類標記)的最後一層隱藏狀態,經過用於輔助預訓練任務的層進一步處理。例如,對於 BERT 家族的模型,這返回經過線性層和 tanh 啟用函式處理後的分類標記。線性層權重在預訓練期間透過下一個句子預測(分類)目標進行訓練。 -
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor)
, optional, 當傳遞output_attentions=True
和config.add_cross_attention=True
或當config.output_attentions=True
時返回) —torch.FloatTensor
的元組(每個層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。解碼器交叉注意力層的注意力權重,在注意力 softmax 之後,用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache
, optional, 當傳遞use_cache=True
或當config.use_cache=True
時返回) — 這是一個 Cache 例項。有關更多詳細資訊,請參閱我們的 kv 快取指南。包含預計算的隱藏狀態(自注意力塊中的鍵和值,如果
config.is_encoder_decoder=True
,則可選地在交叉注意力塊中),可用於(參見past_key_values
輸入)加速順序解碼。
AlignTextModel 前向方法,覆蓋了 __call__
特殊方法。
雖然前向傳播的配方需要在該函式中定義,但此後應呼叫 Module
例項,而不是此函式,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, AlignTextModel
>>> model = AlignTextModel.from_pretrained("kakaobrain/align-base")
>>> tokenizer = AutoTokenizer.from_pretrained("kakaobrain/align-base")
>>> inputs = tokenizer(["a photo of a cat", "a photo of a dog"], padding=True, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_state = outputs.last_hidden_state
>>> pooled_output = outputs.pooler_output # pooled (EOS token) states
AlignVisionModel
class transformers.AlignVisionModel
< source >( config: AlignVisionConfig )
引數
- config (AlignVisionConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,僅載入配置。請檢視 from_pretrained() 方法來載入模型權重。
沒有頭部或投影層的 ALIGN 視覺模型。
此模型繼承自 PreTrainedModel。請檢視超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組,並參考 PyTorch 文件中有關一般用法和行為的所有內容。
forward
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttention
or tuple(torch.FloatTensor)
引數
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, image_size, image_size)
, optional) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}
獲取。有關詳細資訊,請參見{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
處理影像)。 - output_hidden_states (
bool
, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量中的hidden_states
。 - return_dict (
bool
, optional) — 是否返回一個 ModelOutput 物件而不是一個普通元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttention
或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttention
或一個 torch.FloatTensor
元組(如果傳遞 return_dict=False
或當 config.return_dict=False
時),包含根據配置 (AlignConfig) 和輸入的不同元素。
-
last_hidden_state (
torch.FloatTensor
, 形狀為(batch_size, num_channels, height, width)
) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
torch.FloatTensor
, 形狀為(batch_size, hidden_size)
) — 經過空間維度池化操作後的最後一層隱藏狀態。 -
hidden_states (
tuple(torch.FloatTensor)
, optional, 當傳遞output_hidden_states=True
或當config.output_hidden_states=True
時返回) —torch.FloatTensor
的元組(如果模型有嵌入層,則一個用於嵌入層的輸出,加上一個用於每個層的輸出),形狀為(batch_size, num_channels, height, width)
。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
AlignVisionModel 前向方法,覆蓋了 __call__
特殊方法。
雖然前向傳播的配方需要在該函式中定義,但此後應呼叫 Module
例項,而不是此函式,因為前者負責執行預處理和後處理步驟,而後者則默默忽略它們。
示例
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, AlignVisionModel
>>> model = AlignVisionModel.from_pretrained("kakaobrain/align-base")
>>> processor = AutoProcessor.from_pretrained("kakaobrain/align-base")
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> inputs = processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_state = outputs.last_hidden_state
>>> pooled_output = outputs.pooler_output # pooled CLS states