引數

• images (PIL.Image.Image, np.ndarray, torch.Tensor, list[PIL.Image.Image], list[np.ndarray], list[torch.Tensor]) — 要準備的影像或影像批次。每個影像可以是 PIL 影像、NumPy 陣列或 PyTorch 張量。如果是 NumPy 陣列/PyTorch 張量，每個影像的形狀應為 (C, H, W)，其中 C 是通道數，H 和 W 是影像的高度和寬度。
• return_tensors (str 或 TensorType, 可選) — 如果設定，將返回特定框架的張量。可接受的值為：
  • 'tf': 返回 TensorFlow tf.constant 物件。
  • 'pt': 返回 PyTorch torch.Tensor 物件。
  • 'np': 返回 NumPy np.ndarray 物件。
  • 'jax': 返回 JAX jnp.ndarray 物件。

一個具有以下欄位的 BatchFeature

• input_ids — 要輸入到模型中的標記 ID 列表。
• attention_mask — 指定模型應關注哪些 token 的索引列表（當 return_attention_mask=True 或 "attention_mask" 在 self.model_input_names 中且 text 不為 None 時）。
• pixel_values — 要輸入到模型的畫素值。當 images 不為 None 時返回。

引數

• text (str, list[str], list[list[str]]) — 要編碼的序列或序列批次。每個序列可以是字串或字串列表（預分詞字串）。如果序列以字串列表（預分詞）形式提供，則必須設定 is_split_into_words=True（以消除與序列批次之間的歧義）。
• return_tensors (str 或 TensorType, 可選) — 如果設定，將返回特定框架的張量。可接受的值為：
  • 'tf': 返回 TensorFlow tf.constant 物件。
  • 'pt': 返回 PyTorch torch.Tensor 物件。
  • 'np': 返回 NumPy np.ndarray 物件。
  • 'jax': 返回 JAX jnp.ndarray 物件。

一個具有以下欄位的 BatchFeature

• input_ids — 要輸入到模型中的標記 ID 列表。
• attention_mask — 指定模型應關注哪些 token 的索引列表（當 return_attention_mask=True 或 "attention_mask" 在 self.model_input_names 中且 text 不為 None 時）。

引數

• query_embeddings (Union[torch.Tensor, list[torch.Tensor]) — 查詢嵌入。
• passage_embeddings (Union[torch.Tensor, list[torch.Tensor]) — 段落嵌入。
• batch_size (int, 可選, 預設為 128) — 計算分數的批次大小。
• output_dtype (torch.dtype, 可選, 預設為 torch.float32) — 輸出張量的資料型別。如果為 None，則使用輸入嵌入的資料型別。
• output_device (torch.device 或 str, 可選, 預設為“cpu”) — 輸出張量的裝置。

一個形狀為 (n_queries, n_passages) 的張量，包含分數。分數張量儲存到“cpu”裝置上。

引數

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

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

  什麼是輸入 ID？

• attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為 [0, 1]：
  • 1 表示**未被掩碼**的標記，
  • 0 表示**被掩碼**的標記。

  什麼是注意力掩碼？

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

  什麼是位置 ID？

• 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，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有將其過去鍵值狀態提供給此模型的），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。

• labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用於計算掩碼語言建模損失的標籤。索引應在 [0, ..., config.vocab_size] 或 -100 之間（參見 input_ids 文件字串）。索引設定為 -100 的標記將被忽略（掩碼），損失僅針對標籤在 [0, ..., config.vocab_size] 範圍內的標記計算。
• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可選引數，您可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果您希望對 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 而不是純元組。
• pixel_values (torch.Tensor of shape (batch_size, num_channels, image_size, image_size), optional) — 對應於輸入影像的張量。畫素值可以使用 {image_processor_class} 獲取。有關詳細資訊，請參見 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 處理影像）。
• image_grid_thw (torch.LongTensor of shape (num_images, 3), optional) — LLM 中每張影像的特徵形狀的時間、高度和寬度。
• cache_position (torch.LongTensor of shape (sequence_length), optional) — 表示輸入序列標記在序列中位置的索引。與 position_ids 不同，此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。

一個 transformers.models.colqwen2.modeling_colqwen2.ColQwen2ForRetrievalOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (ColQwen2Config) 和輸入而定的各種元素。

• loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。

• embeddings (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size)) — 模型的嵌入。

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量

  包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

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