Hugging Face 的 logo

Transformers 文档

中文-CLIP

Hugging Face's logo
加入Hugging Face社区

并获取增强文档体验

开始使用

中文CLIP

概述

中文CLIP模型在Chinese CLIP: Contrastive Vision-Language Pretraining in Chinese中由An Yang、Junshu Pan、Junyang Lin、Rui Men、Yichang Zhang、Jingren Zhou、Chang Zhou提出。中文CLIP是CLIP（Radford等人，2021）在大型中文图像-文本对数据集上的实现。它能够执行跨模态检索，也可以作为视觉任务（如零样本图像分类、开放域目标检测等）的视觉骨干网络。原始的中文CLIP代码已发布在此链接。

论文摘要如下：

CLIP（Radford等人，2021）的巨大成功推动了对比学习在视觉-语言预训练中的研究和应用。在这项工作中，我们构建了一个大型的中文图像-文本对数据集，其中大部分数据来自公开可用的数据集，并在新数据集上预训练了中文CLIP模型。我们开发了5个不同规模的中文CLIP模型，参数量从7700万到9.58亿不等。此外，我们提出了一种两阶段预训练方法，首先冻结图像编码器进行训练，然后对所有参数进行优化训练，以提高模型性能。我们的综合实验表明，中文CLIP在MUGE、Flickr30K-CN和COCO-CN的零样本学习和微调设置中取得了最先进的性能，并且在基于ELEVATER基准（Li等人，2022）的评估中，在零样本图像分类方面取得了具有竞争力的性能。我们的代码、预训练模型和演示已发布。

中文CLIP模型由OFA-Sys贡献。

使用示例

下面的代码片段展示了如何计算图像和文本特征以及相似度

>>> from PIL import Image
>>> import requests
>>> from transformers import ChineseCLIPProcessor, ChineseCLIPModel

>>> model = ChineseCLIPModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> processor = ChineseCLIPProcessor.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> url = "https://clip-cn-beijing.oss-cn-beijing.aliyuncs.com/pokemon.jpeg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> # Squirtle, Bulbasaur, Charmander, Pikachu in English
>>> texts = ["杰尼龟", "妙蛙种子", "小火龙", "皮卡丘"]

>>> # compute image feature
>>> inputs = processor(images=image, return_tensors="pt")
>>> image_features = model.get_image_features(**inputs)
>>> image_features = image_features / image_features.norm(p=2, dim=-1, keepdim=True)  # normalize

>>> # compute text features
>>> inputs = processor(text=texts, padding=True, return_tensors="pt")
>>> text_features = model.get_text_features(**inputs)
>>> text_features = text_features / text_features.norm(p=2, dim=-1, keepdim=True)  # normalize

>>> # compute image-text similarity scores
>>> inputs = processor(text=texts, images=image, 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)  # probs: [[1.2686e-03, 5.4499e-02, 6.7968e-04, 9.4355e-01]]

目前，以下规模的预训练中文CLIP模型可在 🤗 Hub 上使用：

ChineseCLIPConfig

类 transformers.ChineseCLIPConfig

< >

( text_config = None vision_config = None projection_dim = 512 logit_scale_init_value = 2.6592 **kwargs )

参数

  • text_config (字典, 可选) — 用于初始化 ChineseCLIPTextConfig 的配置选项字典。
  • vision_config (字典, 可选) — 用于初始化 ChineseCLIPVisionConfig 的配置选项字典。
  • projection_dim (整数, 可选, 默认为 512) — 文本和视觉投影层的维度。
  • logit_scale_init_value (浮点数, 可选, 默认为 2.6592) — logit_scale 参数的初始值。默认值与原始中文CLIP实现一致。
  • kwargs (可选) — 关键字参数字典。

ChineseCLIPConfig 是用于存储 ChineseCLIPModel 配置的配置类。它用于根据指定的参数实例化中文 CLIP 模型，定义文本模型和视觉模型的配置。使用默认值实例化配置将生成与中文 CLIP OFA-Sys/chinese-clip-vit-base-patch16 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import ChineseCLIPConfig, ChineseCLIPModel

>>> # Initializing a ChineseCLIPConfig with OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> configuration = ChineseCLIPConfig()

>>> # Initializing a ChineseCLIPModel (with random weights) from the OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> model = ChineseCLIPModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

>>> # We can also initialize a ChineseCLIPConfig from a ChineseCLIPTextConfig and a ChineseCLIPVisionConfig

>>> # Initializing a ChineseCLIPTextConfig and ChineseCLIPVisionConfig configuration
>>> config_text = ChineseCLIPTextConfig()
>>> config_vision = ChineseCLIPVisionConfig()

>>> config = ChineseCLIPConfig.from_text_vision_configs(config_text, config_vision)

from_text_vision_configs

< >

( text_config: ChineseCLIPTextConfig vision_config: ChineseCLIPVisionConfig **kwargs )

从中文 CLIP 文本模型配置和中文 CLIP 视觉模型配置实例化 ChineseCLIPConfig（或派生类）。返回值：ChineseCLIPConfig：配置对象的实例

ChineseCLIPTextConfig

类 transformers.ChineseCLIPTextConfig

< >

( 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 initializer_factor = 1.0 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True **kwargs )

参数

  • vocab_size (int, 可选，默认为 30522) — CHINESE_CLIP 模型的词汇量大小。定义了调用 ChineseCLIPModel 时传递的 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) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float，可选，默认为 0.1) — 注意力概率的 dropout 比率。
  • max_position_embeddings (int，可选，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。
  • type_vocab_size (int，可选，默认为 2) — 调用 ChineseCLIPModel 时传递的 token_type_ids 的词汇量大小。
  • initializer_range (float，可选，默认为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。
  • initializer_factor (float，可选，默认为 1.0) — 初始化所有权重矩阵的因子（应保持为 1，在内部用于初始化测试）。
  • layer_norm_eps (float，可选，默认为 1e-12) — 层归一化层使用的 epsilon。
  • pad_token_id (int，可选，默认为 0) — 填充 token id。
  • use_cache (bool，可选，默认为 True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时相关。

这是用于存储 ChineseCLIPModel 配置的配置类。它用于根据指定的参数实例化一个中文 CLIP 模型，定义模型架构。使用默认值实例化配置将产生与中文 CLIP [OFA-Sys/chinese-clip-vit-base-patch16](https: //huggingface.co/OFA-Sys/chinese-clip-vit-base-patch16) 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import ChineseCLIPTextConfig, ChineseCLIPTextModel

>>> # Initializing a ChineseCLIPTextConfig with OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> configuration = ChineseCLIPTextConfig()

>>> # Initializing a ChineseCLIPTextModel (with random weights) from the OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> model = ChineseCLIPTextModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ChineseCLIPVisionConfig

类 transformers.ChineseCLIPVisionConfig

< >

( hidden_size = 768 intermediate_size = 3072 projection_dim = 512 num_hidden_layers = 12 num_attention_heads = 12 num_channels = 3 image_size = 224 patch_size = 32 hidden_act = 'quick_gelu' layer_norm_eps = 1e-05 attention_dropout = 0.0 initializer_range = 0.02 initializer_factor = 1.0 **kwargs )

参数

  • hidden_size (int，可选，默认为 768) — 编码器层和池化层的维度。
  • intermediate_size (int，可选，默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。
  • projection_dim (int，可选，默认为 512) — 文本和视觉投影层的维度。
  • num_hidden_layers (int，可选，默认为 12) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int，可选，默认为 12) — Transformer 编码器中每个注意力层的注意力头的数量。
  • num_channels (int，可选，默认为 3) — 输入通道的数量。
  • image_size (int, 可选, 默认为 224) — 每个图像的大小（分辨率）。
  • patch_size (int, 可选, 默认为 32) — 每个补丁的大小（分辨率）。
  • hidden_act (str 或 function, 可选, 默认为 "quick_gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"selu" 和 "gelu_new" "quick_gelu"。
  • layer_norm_eps (float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • initializer_factor (float, 可选, 默认为 1.0) — 用于初始化所有权重矩阵的因子（应保持为 1，在内部用于初始化测试）。

这是用于存储 ChineseCLIPModel 配置的配置类。它用于根据指定的参数实例化 ChineseCLIP 模型，定义模型架构。使用默认值实例化配置将产生与 ChineseCLIP OFA-Sys/chinese-clip-vit-base-patch16 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import ChineseCLIPVisionConfig, ChineseCLIPVisionModel

>>> # Initializing a ChineseCLIPVisionConfig with OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> configuration = ChineseCLIPVisionConfig()

>>> # Initializing a ChineseCLIPVisionModel (with random weights) from the OFA-Sys/chinese-clip-vit-base-patch16 style configuration
>>> model = ChineseCLIPVisionModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ChineseCLIPImageProcessor

类 transformers.ChineseCLIPImageProcessor

< >

( do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: Dict = None do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = None do_convert_rgb: bool = True **kwargs )

参数

  • size (Dict[str, int] 可选，默认为 {"shortest_edge" -- 224})：调整大小后图像的大小。图像的最短边调整为 size[“shortest_edge”]，最长边调整为保持输入纵横比。可以在 preprocess 方法中通过 size 覆盖。
  • resample (PILImageResampling，可选，默认为 Resampling.BICUBIC) — 如果调整图像大小，则使用重新采样滤镜。可以在 preprocess 方法中通过 resample 覆盖。
  • do_center_crop (bool，可选，默认为 True) — 是否将图像中心裁剪到指定的 crop_size。可以在 preprocess 方法中通过 do_center_crop 覆盖。
  • crop_size (Dict[str, int] 可选，默认为 224) — 应用 center_crop 后输出图像的大小。可以在 preprocess 方法中通过 crop_size 覆盖。
  • do_rescale (bool，可选，默认为 True) — 是否按指定的比例 rescale_factor 重新缩放图像。可以在 preprocess 方法中通过 do_rescale 覆盖。
  • rescale_factor (int 或 float，可选，默认为 1/255) — 如果重新缩放图像，则使用缩放因子。可以在 preprocess 方法中通过 rescale_factor 覆盖。
  • do_normalize (bool，可选，默认为 True) — 是否标准化图像。可以在 preprocess 方法中通过 do_normalize 覆盖。
  • image_mean (float 或 List[float]，可选，默认为 IMAGENET_STANDARD_MEAN) — 如果标准化图像，则使用均值。这是一个浮点数或浮点数列表，其长度与图像中通道数相同。可以在 preprocess 方法中通过 image_mean 参数覆盖。
  • image_std (float 或 List[float]，可选，默认为 IMAGENET_STANDARD_STD) — 如果标准化图像，则使用标准差。这是一个浮点数或浮点数列表，其长度与图像中通道数相同。可以在 preprocess 方法中通过 image_std 参数覆盖。可以在 preprocess 方法中通过 image_std 参数覆盖。
  • do_convert_rgb (bool，可选，默认为 True) — 是否将图像转换为 RGB。

构造一个中文 CLIP 图像处理器。

预处理

< >

( images: Union do_resize: bool = None size: Dict = None resample: Resampling = None do_center_crop: bool = None crop_size: int = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None do_convert_rgb: bool = None return_tensors: Union = None data_format: Optional = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )

参数

  • 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 或 List[float], 可选, 默认为 self.image_mean) — 用于标准化的图像均值。仅当 do_normalize 设置为 True 时才有效。
  • image_std (float 或 List[float], 可选, 默认为 self.image_std) — 用于标准化的图像标准差。仅当 do_normalize 设置为 True 时才有效。
  • do_convert_rgb (bool, 可选, 默认为 self.do_convert_rgb) — 是否将图像转换为 RGB。
  • 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) — 输出图像的通道维度格式。可以是以下之一：
    • "channels_first" 或 ChannelDimension.FIRST：图像采用 (num_channels, height, width) 格式。
    • "channels_last" 或 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) 格式。

预处理图像或图像批次。

ChineseCLIPFeatureExtractor

类 transformers.ChineseCLIPFeatureExtractor

< >

( *args **kwargs )

ChineseCLIPProcessor

类 transformers.ChineseCLIPProcessor

< >

( image_processor = None tokenizer = None **kwargs )

参数

构建一个中文CLIP处理器，它将中文CLIP图像处理器和中文CLIP分词器封装到一个处理器中。

ChineseCLIPProcessor 提供了 ChineseCLIPImageProcessor 和 BertTokenizerFast 的所有功能。有关更多信息，请参阅 __call__() 和 decode()。

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发到 BertTokenizerFast 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。

decode

< >

( *args **kwargs )

此方法将其所有参数转发到 BertTokenizerFast 的 decode()。有关更多信息，请参阅此方法的文档字符串。

ChineseCLIPModel

类 transformers.ChineseCLIPModel

< >

( config: ChineseCLIPConfig )

参数

  • config (ChineseCLIPConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。

此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

forward

< >

( input_ids: Optional = None pixel_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None return_loss: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.chinese_clip.modeling_chinese_clip.ChineseCLIPOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_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, sequence_length)，可选) — 用于指示输入第一部分和第二部分的段标记索引。在 [0, 1] 中选择索引：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是标记类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。默认情况下，如果您提供填充，则会忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ChineseCLIPImageProcessor.call()。
  • return_loss (bool，可选) — 是否返回对比损失。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.models.chinese_clip.modeling_chinese_clip.ChineseCLIPOutput 或 tuple(torch.FloatTensor)

返回一个 transformers.models.chinese_clip.modeling_chinese_clip.ChineseCLIPOutput 对象，或者一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False）。包含的元素取决于配置（<class 'transformers.models.chinese_clip.configuration_chinese_clip.ChineseCLIPConfig'>）和输入。

  • 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) — 通过将 ChineseCLIPTextModel 的池化输出应用于投影层获得的文本嵌入。
  • image_embeds(torch.FloatTensor，形状为 (batch_size, output_dim) — 通过将 ChineseCLIPVisionModel 的池化输出应用于投影层获得的图像嵌入。
  • text_model_output(BaseModelOutputWithPoolingAndCrossAttentions): ChineseCLIPTextModel 的输出。
  • vision_model_output(BaseModelOutputWithPoolingAndCrossAttentions): ChineseCLIPVisionModel 的输出。

ChineseCLIPModel 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的流程需要在这个函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。

示例

>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, ChineseCLIPModel

>>> model = ChineseCLIPModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> processor = AutoProcessor.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> url = "https://clip-cn-beijing.oss-cn-beijing.aliyuncs.com/pokemon.jpeg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = processor(text=["杰尼龟", "妙蛙种子", "小火龙", "皮卡丘"], images=image, 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

获取文本特征

< >

( input_ids: 可选 attention_mask: 可选 token_type_ids: 可选 position_ids: 可选 output_attentions: 可选 output_hidden_states: 可选 return_dict: 可选 ) → text_features (torch.FloatTensor，形状为 (batch_size, output_dim)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 ID？

  • attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：

    • 1 表示未被掩盖的标记，
    • 0 表示被掩盖的标记。

    什么是注意力掩码？

  • token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引选择在 [0, 1] 中：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是标记类型 ID？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为 [0, config.max_position_embeddings - 1]。

    什么是位置 ID？

  • head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 中：

    • 1 表示头部未被掩盖，
    • 0 表示头部被掩盖。
  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型内部的嵌入查找矩阵，这将非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

text_features (torch.FloatTensor 形状为 (batch_size, output_dim)

通过将文本转换器的最终[CLS]隐藏状态应用于投影层获得的文本嵌入。

ChineseCLIPModel 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的流程需要在这个函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。

示例

>>> from transformers import AutoTokenizer, ChineseCLIPModel

>>> model = ChineseCLIPModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> tokenizer = AutoTokenizer.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> inputs = tokenizer(["杰尼龟", "妙蛙种子", "小火龙", "皮卡丘"], padding=True, return_tensors="pt")
>>> text_features = model.get_text_features(**inputs)
>>> text_features = text_features / text_features.norm(p=2, dim=-1, keepdim=True)

get_image_features

< >

( pixel_values: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → image_features (torch.FloatTensor 形状为 (batch_size, output_dim)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，则默认情况下将忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ChineseCLIPImageProcessor.call()。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

image_features (torch.FloatTensor 形状为 (batch_size, output_dim)

通过将视觉转换器的最终[CLS]隐藏状态应用于投影层获得的图像嵌入。

ChineseCLIPModel 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的流程需要在这个函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。

示例

>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, ChineseCLIPModel

>>> model = ChineseCLIPModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> processor = AutoProcessor.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> url = "https://clip-cn-beijing.oss-cn-beijing.aliyuncs.com/pokemon.jpeg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = processor(images=image, return_tensors="pt")

>>> image_features = model.get_image_features(**inputs)
>>> image_features = image_features / image_features.norm(p=2, dim=-1, keepdim=True)

ChineseCLIPTextModel

类 transformers.ChineseCLIPTextModel

< >

( config add_pooling_layer = True )

参数

  • config (ChineseCLIPConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

CHINESE_CLIP 的文本模型，没有任何头部或顶部的投影。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。

该模型可以充当编码器（仅使用自注意力）以及解码器，在这种情况下，在自注意力层之间添加一层交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。

要充当解码器，模型需要使用配置的is_decoder参数设置为True进行初始化。要在 Seq2Seq 模型中使用，模型需要同时使用is_decoder参数和add_cross_attention设置为True进行初始化；然后将encoder_hidden_states作为输入传递给前向传递。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_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, sequence_length)，可选) — 用于指示输入第一部分和第二部分的片段标记索引。索引选择在 [0, 1] 中：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是标记类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为 [0, config.max_position_embeddings - 1]。

    什么是位置 ID？

  • 像素值 (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ChineseCLIPImageProcessor.call()。
  • return_loss (bool, 可选) — 是否返回对比损失。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。
  • encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在 [0, 1] 中：

    • 1 表示未掩码的标记，
    • 0 表示掩码的标记。
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers，每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values，则用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids（没有为此模型提供其过去键值状态的那些），而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。

  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

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), 可选，当传递 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后的权重，用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 和 config.add_cross_attention=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组 (每个层一个)。

    解码器交叉注意力层的注意力权重，注意力softmax之后，用于计算交叉注意力头中的加权平均值。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，并且如果 config.is_encoder_decoder=True，则可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的张量。

    包含预计算的隐藏状态（自注意力块中的键和值，以及如果 config.is_encoder_decoder=True，则可选地在交叉注意力块中），可用于（参见 past_key_values 输入）加速顺序解码。

ChineseCLIPTextModel 的前向方法，重写了 __call__ 特殊方法。

虽然前向传递的流程需要在这个函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。

示例

>>> from transformers import AutoTokenizer, ChineseCLIPTextModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> model = ChineseCLIPTextModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

ChineseCLIPVisionModel

类 transformers.ChineseCLIPVisionModel

< >

( config: ChineseCLIPVisionConfig )

参数

  • config (ChineseCLIPConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。

CHINESE_CLIP 的视觉模型，没有任何头部或顶部的投影。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

forward

< >

( pixel_values: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。默认情况下会忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ChineseCLIPImageProcessor.call()。
  • 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），包含取决于配置 (<class 'transformers.models.chinese_clip.configuration_chinese_clip.ChineseCLIPVisionConfig'>) 和输入的各种元素。

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

ChineseCLIPVisionModel 的前向方法，重写了 __call__ 特殊方法。

虽然前向传递的流程需要在这个函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。

示例

>>> from PIL import Image
>>> import requests
>>> from transformers import CLIPProcessor, ChineseCLIPVisionModel

>>> model = ChineseCLIPVisionModel.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")
>>> processor = CLIPProcessor.from_pretrained("OFA-Sys/chinese-clip-vit-base-patch16")

>>> url = "https://clip-cn-beijing.oss-cn-beijing.aliyuncs.com/pokemon.jpeg"
>>> 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
< > GitHub 上的更新

←Chameleon CLIP→