参数

• 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 后的注意力权重，用于计算自注意力头中的加权平均值。