引數

• images (ImageInput) — 待預處理的影像。需要單個或一批畫素值在 0 到 255 範圍內的影像。如果傳入畫素值在 0 到 1 之間的影像，請設定 do_rescale=False。
• do_resize (bool, 可選, 預設為 self.do_resize) — 是否調整影像大小。
• size (dict[str, int], 可選, 預設為 self.size) — 調整大小後圖像的尺寸。影像的最短邊被調整為 size[“shortest_edge”]，最長邊則按比例調整以保持輸入影像的寬高比。
• 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) — 是否對影像進行縮放。
• rescale_factor (float, 可選, 預設為 self.rescale_factor) — 如果 do_rescale 設定為 True，則用於縮放影像的縮放因子。
• do_normalize (bool, 可選, 預設為 self.do_normalize) — 是否對影像進行歸一化。
• image_mean (float or list[float], 可選, 預設為 self.image_mean) — 用於歸一化的影像均值。僅在 do_normalize 設定為 True 時生效。
• image_std (float or list[float], 可選, 預設為 self.image_std) — 用於歸一化的影像標準差。僅在 do_normalize 設定為 True 時生效。
• do_convert_rgb (bool, 可選, 預設為 self.do_convert_rgb) — 是否將影像轉換為 RGB。
• return_tensors (str or 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 or str, 可選, 預設為 ChannelDimension.FIRST) — 輸出影像的通道維度格式。可以是以下之一：
  • "channels_first" 或 ChannelDimension.FIRST：影像格式為 (num_channels, height, width)。
  • "channels_last" 或 ChannelDimension.LAST：影像格式為 (height, width, num_channels)。
  • 未設定：使用輸入影像的通道維度格式。
• input_data_format (ChannelDimension or str, 可選) — 輸入影像的通道維度格式。如果未設定，則從輸入影像中推斷通道維度格式。可以是以下之一：
  • "channels_first" 或 ChannelDimension.FIRST：影像格式為 (num_channels, height, width)。
  • "channels_last" 或 ChannelDimension.LAST：影像格式為 (height, width, num_channels)。
  • "none" 或 ChannelDimension.NONE：影像格式為 (height, width)。

引數

• 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

• data (dict) — 由 call 方法返回的列表/陣列/張量字典（“pixel_values”等）。
• tensor_type (Union[None, str, TensorType], 可選) — 您可以在此處提供一個`tensor_type`，以便在初始化時將整數列表轉換為PyTorch/TensorFlow/Numpy張量。

引數

• input_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

  索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什麼是輸入 ID？

• pixel_values (形狀為 (batch_size, num_channels, image_size, image_size) 的 torch.FloatTensor, 可選) — 對應於輸入影像的張量。畫素值可以使用 {image_processor_class} 獲得。詳情請參閱 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 處理影像）。
• attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
  • 1 表示**未被掩碼**的標記，
  • 0 表示**被掩碼**的標記。

  什麼是注意力掩碼？

• token_type_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
  • 0 對應於*句子 A* 的標記，
  • 1 對應於*句子 B* 的標記。

  什麼是標記型別 ID？

• position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

  什麼是位置 ID？

• return_loss (bool, 可選) — 是否返回對比損失。
• output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 `attentions`。
• output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 `hidden_states`。
• interpolate_pos_encoding (bool, 預設為 False) — 是否對預訓練的位置編碼進行插值。
• return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

一個 transformers.models.chinese_clip.modeling_chinese_clip.ChineseCLIPOutput 或一個 `torch.FloatTensor` 元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（ChineseCLIPConfig）和輸入包含不同的元素。

• loss (torch.FloatTensor，形狀為 (1,), 可選, 當 return_loss 為 True 時返回) — 影像-文字相似度的對比損失。
• logits_per_image (形狀為 (image_batch_size, text_batch_size) 的 torch.FloatTensor) — image_embeds 和 text_embeds 之間的縮放點積得分。這表示影像-文字相似性得分。
• logits_per_text (形狀為 (text_batch_size, image_batch_size) 的 torch.FloatTensor) — text_embeds 和 image_embeds 之間的縮放點積得分。這表示文字-影像相似性得分。
• text_embeds (形狀為 (batch_size, output_dim 的 torch.FloatTensor) — 透過將投影層應用於 ChineseCLIPTextModel 的池化輸出而獲得的文字嵌入。
• image_embeds (形狀為 (batch_size, output_dim 的 torch.FloatTensor) — 透過將投影層應用於 ChineseCLIPVisionModel 的池化輸出而獲得的影像嵌入。
• text_model_output (<class '~modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions'>.text_model_output, 預設為 None) — ChineseCLIPTextModel 的輸出。
• vision_model_output (<class '~modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions'>.vision_model_output, 預設為 None) — ChineseCLIPVisionModel 的輸出。

引數

• input_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

  索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什麼是輸入 ID？

• attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
  • 1 表示**未被掩碼**的標記，
  • 0 表示**被掩碼**的標記。

  什麼是注意力掩碼？

• token_type_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
  • 0 對應於*句子 A* 的標記，
  • 1 對應於*句子 B* 的標記。

  什麼是標記型別 ID？

• position_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

  什麼是位置 ID？

• output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 `attentions`。
• output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 `hidden_states`。
• return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

透過將投影層應用於 Text-Transformer 的最終 [CLS] 隱藏狀態而獲得的文字嵌入。

引數

• pixel_values (形狀為 (batch_size, num_channels, image_size, image_size) 的 torch.FloatTensor, 可選) — 對應於輸入影像的張量。畫素值可以使用 {image_processor_class} 獲得。詳情請參閱 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 處理影像）。
• output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 `attentions`。
• output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 `hidden_states`。
• interpolate_pos_encoding (bool, 預設為 False) — 是否對預訓練的位置編碼進行插值。
• return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

透過將投影層應用於 Vision-Transformer 的最終 [CLS] 隱藏狀態而獲得的影像嵌入。

引數

• input_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，optional) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。

  可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什麼是輸入 ID？

• attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，optional) — 用於避免對填充詞元索引執行注意力計算的掩碼。掩碼值在 [0, 1] 中選擇：
  • 1 表示詞元未被遮蔽，
  • 0 表示詞元被遮蔽。

  什麼是注意力掩碼？

• token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，optional) — 分段詞元索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
  • 0 對應於 *句子 A* 的詞元，
  • 1 對應於 *句子 B* 的詞元。

  什麼是詞元型別 ID？

• position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，optional) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

  什麼是位置 ID？

• head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，optional) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在 [0, 1] 中選擇：
  • 1 表示頭未被遮蔽，
  • 0 表示頭被遮蔽。
• inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，optional) — 可選地，你可以直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這會很有用。
• encoder_hidden_states (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，optional) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力中使用。
• encoder_attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，optional) — 用於避免對編碼器輸入的填充詞元索引執行注意力計算的掩碼。如果模型被配置為解碼器，此掩碼將在交叉注意力中使用。掩碼值在 [0, 1] 中選擇：
  • 1 表示詞元未被遮蔽，
  • 0 表示詞元被遮蔽。
• past_key_values (list[torch.FloatTensor]，optional) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的前一個階段由模型返回的 past_key_values，此時 use_cache=True 或 config.use_cache=True。

  允許兩種格式：

  • 一個 Cache 例項，請參閱我們的 kv cache 指南；
  • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組有兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊版快取格式。

  模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回舊版快取格式。

  如果使用了 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有為其提供過去鍵值狀態的詞元），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

• use_cache (bool，optional) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（請參閱 past_key_values）。
• output_attentions (bool，optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
• output_hidden_states (bool，optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
• return_dict (bool，optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（ChineseCLIPConfig）和輸入，包含各種元素。

• last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

• pooler_output (torch.FloatTensor，形狀為 (batch_size, hidden_size)) — 序列的第一個詞元（分類詞元）的最後一層隱藏狀態，經過用於輔助預訓練任務的層的進一步處理。例如，對於 BERT 家族的模型，這返回經過線性層和 tanh 啟用函式處理後的分類詞元。線性層權重是在預訓練期間從下一句預測（分類）目標中訓練的。

• hidden_states (tuple(torch.FloatTensor)，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 cache 指南。

  包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果 config.is_encoder_decoder=True，則可選地在交叉注意力塊中），可用於（參見 past_key_values 輸入）加速順序解碼。

引數

• pixel_values (torch.FloatTensor，形狀為 (batch_size, num_channels, image_size, image_size)，optional) — 對應於輸入影像的張量。可以使用 {image_processor_class} 獲取畫素值。有關詳細資訊，請參閱 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 處理影像）。
• output_attentions (bool，optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
• output_hidden_states (bool，optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
• interpolate_pos_encoding (bool，預設為 False) — 是否對預訓練的位置編碼進行插值。
• return_dict (bool，optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

一個 transformers.modeling_outputs.BaseModelOutputWithPooling 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（ChineseCLIPConfig）和輸入，包含各種元素。

• last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

• pooler_output (torch.FloatTensor，形狀為 (batch_size, hidden_size)) — 序列的第一個詞元（分類詞元）的最後一層隱藏狀態，經過用於輔助預訓練任務的層的進一步處理。例如，對於 BERT 家族的模型，這返回經過線性層和 tanh 啟用函式處理後的分類詞元。線性層權重是在預訓練期間從下一句預測（分類）目標中訓練的。

• hidden_states (tuple(torch.FloatTensor)，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 後的注意力權重，用於計算自注意力頭中的加權平均值。