Transformers 文档
ViLT
并获得增强的文档体验
开始使用
ViLT
概述
ViLT 模型由 Wonjae Kim、Bokyung Son 和 Ildoo Kim 在论文 ViLT：无需卷积或区域监督的视觉-语言 Transformer 中提出。ViLT 将文本嵌入整合到视觉 Transformer (ViT) 中，使其能够以最小化的设计进行视觉与语言预训练 (VLP)。
论文摘要如下：
视觉与语言预训练 (VLP) 提高了各种联合视觉与语言下游任务的性能。当前的 VLP 方法严重依赖于图像特征提取过程，其中大多数涉及区域监督（例如，对象检测）和卷积架构（例如，ResNet）。尽管在文献中被忽视，但我们发现在 (1) 效率/速度方面存在问题，即简单地提取输入特征比多模态交互步骤需要更多的计算；(2) 在表达能力方面，其上限受限于视觉嵌入器的表达能力及其预定义的视觉词汇表。在本文中，我们提出了一个最小化的 VLP 模型，即视觉-语言 Transformer (ViLT)，它在某种意义上是单体的，因为视觉输入的处理被极大地简化为与处理文本输入相同的无卷积方式。我们证明 ViLT 比以前的 VLP 模型快数十倍，同时具有相当或更好的下游任务性能。
ViLT 架构。摘自原始论文。 使用技巧
- 开始使用 ViLT 的最快方法是查看示例笔记本（其中展示了在自定义数据上的推理和微调）。
- ViLT 是一个同时接受 `pixel_values` 和 `input_ids` 作为输入的模型。可以使用 ViltProcessor 来为模型准备数据。该处理器将图像处理器（用于图像模态）和分词器（用于语言模态）封装在一起。
- ViLT 使用不同尺寸的图像进行训练：作者将输入图像的短边调整为 384，并将长边限制在 640 以下，同时保持长宽比。为了实现图像的批处理，作者使用了 `pixel_mask` 来指示哪些像素值是真实的，哪些是填充。 ViltProcessor 会自动为你创建这个掩码。
- ViLT 的设计与标准的视觉 Transformer (ViT) 非常相似。唯一的区别是该模型为语言模态包含了额外的嵌入层。
- 此模型的 PyTorch 版本仅在 torch 1.10 及更高版本中可用。
ViltConfig
class transformers.ViltConfig
< 来源 >( vocab_size = 30522 type_vocab_size = 2 modality_type_vocab_size = 2 max_position_embeddings = 40 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 initializer_range = 0.02 layer_norm_eps = 1e-12 image_size = 384 patch_size = 32 num_channels = 3 qkv_bias = True max_image_length = -1 tie_word_embeddings = False num_images = -1 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — 模型文本部分的词汇表大小。定义了在调用 ViltModel 时，可以通过 `inputs_ids` 表示的不同标记的数量。 - type_vocab_size (
int, 可选, 默认为 2) — 在调用 ViltModel 时传递的 `token_type_ids` 的词汇表大小。这在编码文本时使用。 - modality_type_vocab_size (
int, 可选, 默认为 2) — 在调用 ViltModel 时传递的模态词汇表大小。这在连接文本和图像模态的嵌入后使用。 - max_position_embeddings (
int, 可选, 默认为 40) — 该模型可能使用的最大序列长度。 - hidden_size (
int, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，支持 `"gelu"`、`"relu"`、`"selu"` 和 `"gelu_new"`。 - hidden_dropout_prob (
float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.0) — 注意力概率的丢弃率。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - image_size (
int, 可选, 默认为 384) — 每个图像的大小（分辨率）。 - patch_size (
int, 可选, 默认为 32) — 每个图像块的大小（分辨率）。 - num_channels (
int, 可选, 默认为 3) — 输入通道的数量。 - qkv_bias (
bool, 可选, 默认为 `True`) — 是否为查询、键和值添加偏置。 - max_image_length (
int, 可选, 默认为 -1) — Transformer 编码器接受的最大图像块数量。如果设置为正整数，编码器将最多采样 `max_image_length` 个图像块。如果设置为 -1，则不考虑此参数。 - num_images (
int, 可选, 默认为 -1) — 用于自然语言视觉推理的图像数量。如果设置为正整数，ViltForImagesAndTextClassification 将用它来定义分类器头。
这是一个用于存储 `ViLTModel` 配置的配置类。它用于根据指定的参数实例化一个 ViLT 模型，定义模型架构。使用默认值实例化配置将产生与 ViLT dandelin/vilt-b32-mlm 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import ViLTModel, ViLTConfig
>>> # Initializing a ViLT dandelin/vilt-b32-mlm style configuration
>>> configuration = ViLTConfig()
>>> # Initializing a model from the dandelin/vilt-b32-mlm style configuration
>>> model = ViLTModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configViltFeatureExtractor
预处理单张或批量图像。
ViltImageProcessor
class transformers.ViltImageProcessor
< 来源 >( do_resize: bool = True size: typing.Optional[dict[str, int]] = None size_divisor: int = 32 resample: Resampling = <Resampling.BICUBIC: 3> do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_pad: bool = True **kwargs )
参数
- do_resize (
bool, 可选, 默认为 `True`) — 是否将图像的（高度，宽度）尺寸调整为指定的 `size`。可以在 `preprocess` 方法中通过 `do_resize` 参数覆盖。 - size (
dict[str, int]可选, 默认为 `{"shortest_edge" -- 384}`): 将输入图像的短边调整为 `size["shortest_edge"]`。长边将被限制在 `int((1333 / 800) * size["shortest_edge"])` 以下，同时保持长宽比。仅在 `do_resize` 设置为 `True` 时有效。可以在 `preprocess` 方法中通过 `size` 参数覆盖。 - size_divisor (
int, 可选, 默认为 32) — 确保高度和宽度都可以被其整除的大小。仅在 `do_resize` 设置为 `True` 时有效。可以在 `preprocess` 方法中通过 `size_divisor` 参数覆盖。 - resample (
PILImageResampling, 可选, 默认为 `Resampling.BICUBIC`) — 如果调整图像大小，使用的重采样过滤器。仅在 `do_resize` 设置为 `True` 时有效。可以在 `preprocess` 方法中通过 `resample` 参数覆盖。 - do_rescale (
bool, 可选, 默认为True) — 是否通过指定的缩放比例rescale_factor对图像进行缩放。可以在preprocess方法中使用do_rescale参数进行覆盖。 - rescale_factor (
int或float, 可选, 默认为1/255) — 如果对图像进行缩放，则使用的缩放因子。仅当do_rescale设置为True时有效。可以在preprocess方法中使用rescale_factor参数进行覆盖。 - do_normalize (
bool, 可选, 默认为True) — 是否对图像进行归一化。可以在preprocess方法中使用do_normalize参数进行覆盖。可以在preprocess方法中使用do_normalize参数进行覆盖。 - image_mean (
float或list[float], 可选, 默认为IMAGENET_STANDARD_MEAN) — 如果对图像进行归一化，则使用的均值。这是一个浮点数或浮点数列表，其长度与图像中的通道数相同。可以在preprocess方法中使用image_mean参数进行覆盖。可以在preprocess方法中使用image_mean参数进行覆盖。 - image_std (
float或list[float], 可选, 默认为IMAGENET_STANDARD_STD) — 如果对图像进行归一化，则使用的标准差。这是一个浮点数或浮点数列表，其长度与图像中的通道数相同。可以在preprocess方法中使用image_std参数进行覆盖。可以在preprocess方法中使用image_std参数进行覆盖。 - do_pad (
bool, 可选, 默认为True) — 是否将图像填充到批次中图像的(max_height, max_width)。可以在preprocess方法中使用do_pad参数进行覆盖。
构建一个 ViLT 图像处理器。
preprocess
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None size_divisor: typing.Optional[int] = None resample: Resampling = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_pad: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )
参数
- images (
ImageInput) — 待预处理的图像。需要单个或一批像素值在 0 到 255 范围内的图像。如果传入的图像像素值在 0 到 1 之间，请设置do_rescale=False。 - do_resize (
bool, 可选, 默认为self.do_resize) — 是否调整图像大小。 - size (
dict[str, int], 可选, 默认为self.size) — 控制 `resize` 后图像的大小。图像的最短边被调整为 `size["shortest_edge"]`，同时保持纵横比。如果调整大小后图像的最长边大于 `int(size["shortest_edge"] * (1333 / 800))`，则再次调整图像大小，使最长边等于 `int(size["shortest_edge"] * (1333 / 800))`。 - size_divisor (
int, 可选, 默认为self.size_divisor) — 图像被调整到该值的倍数大小。 - resample (
PILImageResampling, 可选, 默认为self.resample) — 如果调整图像大小，则使用的重采样滤波器。仅当do_resize设置为True时有效。 - do_rescale (
bool, 可选, 默认为self.do_rescale) — 是否将图像值缩放到 [0 - 1] 之间。 - 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_pad (
bool, 可选, 默认为self.do_pad) — 是否将图像填充到批次中的 (max_height, max_width)。如果为 `True`，则还会创建并返回一个像素掩码。 - 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) — 输出图像的通道维度格式。可以是以下之一：ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。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)。
预处理一张或一批图像。
ViltImageProcessorFast
class transformers.ViltImageProcessorFast
< source >( **kwargs: typing_extensions.Unpack[transformers.image_processing_utils_fast.DefaultFastImageProcessorKwargs] )
构建一个快速的 Vilt 图像处理器。
preprocess
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] *args **kwargs: typing_extensions.Unpack[transformers.image_processing_utils_fast.DefaultFastImageProcessorKwargs] ) → <class 'transformers.image_processing_base.BatchFeature'>
参数
- 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
返回
<class 'transformers.image_processing_base.BatchFeature'>
- data (
dict) — 由 call 方法返回的列表/数组/张量字典（“pixel_values”等）。 - tensor_type (
Union[None, str, TensorType], 可选) — 您可以在此处提供一个`tensor_type`，以便在初始化时将整数列表转换为PyTorch/TensorFlow/Numpy张量。
ViltProcessor
class transformers.ViltProcessor
< source >( image_processor = None tokenizer = None **kwargs )
参数
- image_processor (
ViltImageProcessor, 可选) — ViltImageProcessor 的一个实例。图像处理器是必需的输入。 - tokenizer (
BertTokenizerFast, 可选) — [`BertTokenizerFast`] 的一个实例。分词器是必需的输入。
构建一个 ViLT 处理器，它将 BERT 分词器和 ViLT 图像处理器包装成单个处理器。
ViltProcessor 提供 ViltImageProcessor 和 BertTokenizerFast 的所有功能。有关更多信息，请参阅 call() 和 `decode()` 的文档字符串。
__call__
< source >( images text: typing.Union[str, list[str], list[list[str]]] = None add_special_tokens: bool = True padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False truncation: typing.Union[bool, str, transformers.tokenization_utils_base.TruncationStrategy] = None max_length: typing.Optional[int] = None stride: int = 0 pad_to_multiple_of: typing.Optional[int] = None return_token_type_ids: typing.Optional[bool] = None return_attention_mask: typing.Optional[bool] = None return_overflowing_tokens: bool = False return_special_tokens_mask: bool = False return_offsets_mapping: bool = False return_length: bool = False verbose: bool = True return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None **kwargs )
此方法使用 ViltImageProcessor.__call__() 方法为模型准备图像，并使用 BertTokenizerFast.__call__() 为模型准备文本。
有关更多信息，请参阅上述两种方法的文档字符串。
ViltModel
class transformers.ViltModel
< source >( config add_pooling_layer = True )
参数
- config (ViltModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, optional, 默认为True) — 是否添加一个池化层
裸 Vilt 模型，输出原始的隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None image_token_type_idx: typing.Optional[int] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 用于指示输入的第一和第二部分的片段标记索引。索引选自[0, 1]：- 0 对应于*句子 A* 的标记，
- 1 对应于*句子 B* 的标记。
- 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}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), optional) — 用于避免对填充像素值执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即已被遮盖）。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头已被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更灵活地控制如何将input_ids索引转换为相关向量，这会很有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), optional) — 可选地，你可以不传递pixel_values，而是直接传递嵌入表示。如果你想更灵活地控制如何将pixel_values转换为补丁嵌入，这会很有用。 - image_token_type_idx (
int, optional) —- 图像的标记类型 ID。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltModel 的 forward 方法重写了 `__call__` 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import ViltProcessor, ViltModel
>>> from PIL import Image
>>> import requests
>>> # prepare image and text
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> text = "hello world"
>>> processor = ViltProcessor.from_pretrained("dandelin/vilt-b32-mlm")
>>> model = ViltModel.from_pretrained("dandelin/vilt-b32-mlm")
>>> inputs = processor(image, text, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateViltForMaskedLM
class transformers.ViltForMaskedLM
< 源码 >( config )
参数
- config (ViltForMaskedLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
ViLT 模型，顶部带有语言建模头，与预训练时一样。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 用于指示输入的第一和第二部分的片段标记索引。索引选自[0, 1]：- 0 对应于*句子 A* 的标记，
- 1 对应于*句子 B* 的标记。
- 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}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), optional) — 用于避免对填充像素值执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即已被遮盖）。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头已被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更灵活地控制如何将input_ids索引转换为相关向量，这会很有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), optional) — 可选地，你可以不传递pixel_values，而是直接传递嵌入表示。如果你想更灵活地控制如何将pixel_values转换为补丁嵌入，这会很有用。 - labels (
*torch.LongTensor*，形状为 *(batch_size, sequence_length)*, optional) — 用于计算遮盖语言建模损失的标签。索引应在 *[-100, 0, …, config.vocab_size]* 范围内（参见 *input_ids* 文档字符串）。索引设置为 *-100* 的标记将被忽略（遮盖），损失仅对标签在 *[0, …, config.vocab_size]* 范围内的标记计算。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltForMaskedLM 的 forward 方法重写了 `__call__` 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import ViltProcessor, ViltForMaskedLM
>>> import requests
>>> from PIL import Image
>>> import re
>>> import torch
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> text = "a bunch of [MASK] laying on a [MASK]."
>>> processor = ViltProcessor.from_pretrained("dandelin/vilt-b32-mlm")
>>> model = ViltForMaskedLM.from_pretrained("dandelin/vilt-b32-mlm")
>>> # prepare inputs
>>> encoding = processor(image, text, return_tensors="pt")
>>> # forward pass
>>> outputs = model(**encoding)
>>> tl = len(re.findall("\[MASK\]", text))
>>> inferred_token = [text]
>>> # gradually fill in the MASK tokens, one by one
>>> with torch.no_grad():
... for i in range(tl):
... encoded = processor.tokenizer(inferred_token)
... input_ids = torch.tensor(encoded.input_ids)
... encoded = encoded["input_ids"][0][1:-1]
... outputs = model(input_ids=input_ids, pixel_values=encoding.pixel_values)
... mlm_logits = outputs.logits[0] # shape (seq_len, vocab_size)
... # only take into account text features (minus CLS and SEP token)
... mlm_logits = mlm_logits[1 : input_ids.shape[1] - 1, :]
... mlm_values, mlm_ids = mlm_logits.softmax(dim=-1).max(dim=-1)
... # only take into account text
... mlm_values[torch.tensor(encoded) != 103] = 0
... select = mlm_values.argmax().item()
... encoded[select] = mlm_ids[select].item()
... inferred_token = [processor.decode(encoded)]
>>> selected_token = ""
>>> encoded = processor.tokenizer(inferred_token)
>>> output = processor.decode(encoded.input_ids[0], skip_special_tokens=True)
>>> print(output)
a bunch of cats laying on a couch.ViltForQuestionAnswering
class transformers.ViltForQuestionAnswering
< 源码 >( config )
参数
- config (ViltForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Vilt 模型 Transformer，顶部带有一个分类器头（在 [CLS] 标记的最终隐藏状态上加一个线性层），用于视觉问答，例如 VQAv2。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 用于指示输入的第一和第二部分的片段标记索引。索引选自[0, 1]：- 0 对应于*句子 A* 的标记，
- 1 对应于*句子 B* 的标记。
- 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}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), optional) — 用于避免对填充像素值执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即已被遮盖）。
- head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头已被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更灵活地控制如何将input_ids索引转换为相关向量，这会很有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), optional) — 可选地，你可以不传递pixel_values，而是直接传递嵌入表示。如果你想更灵活地控制如何将pixel_values转换为补丁嵌入，这会很有用。 - labels (
torch.FloatTensor，形状为(batch_size, num_labels), optional) — 用于计算视觉问答损失的标签。此张量必须是批次中给定示例适用的所有答案的独热编码，或者是表示哪些答案适用的软编码，其中 1.0 是最高分。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltForQuestionAnswering 的 forward 方法重写了 `__call__` 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import ViltProcessor, ViltForQuestionAnswering
>>> import requests
>>> from PIL import Image
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> text = "How many cats are there?"
>>> processor = ViltProcessor.from_pretrained("dandelin/vilt-b32-finetuned-vqa")
>>> model = ViltForQuestionAnswering.from_pretrained("dandelin/vilt-b32-finetuned-vqa")
>>> # prepare inputs
>>> encoding = processor(image, text, return_tensors="pt")
>>> # forward pass
>>> outputs = model(**encoding)
>>> logits = outputs.logits
>>> idx = logits.argmax(-1).item()
>>> print("Predicted answer:", model.config.id2label[idx])
Predicted answer: 2ViltForImagesAndTextClassification
class transformers.ViltForImagesAndTextClassification
< 源码 >( config )
参数
- config (ViltForImagesAndTextClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Vilt 模型 Transformer，顶部带有一个分类器头，用于自然语言视觉推理，例如 NLVR2。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.vilt.modeling_vilt.ViltForImagesAndTextClassificationOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的标记。
- pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size), 可选) — 对应于输入图像的张量。可以使用{image_processor_class}获取像素值。有关详细信息，请参阅{image_processor_class}.__call__（{processor_class}使用{image_processor_class}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), 可选) — 用于避免在填充像素值上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即被遮盖）。
- 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索引转换为关联向量，这将非常有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), 可选) — 可选地， вместо传递pixel_values，您可以选择直接传递嵌入式表示。如果您想更多地控制如何将pixel_values转换为补丁嵌入，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,), 可选) — 二元分类标签。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.vilt.modeling_vilt.ViltForImagesAndTextClassificationOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.vilt.modeling_vilt.ViltForImagesAndTextClassificationOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
list[tuple(torch.FloatTensor)], 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组列表（每个图像-文本对一个，每个元组包含嵌入的输出 + 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出处的隐藏状态以及初始嵌入输出。 -
attentions (
list[tuple[torch.FloatTensor]], 可选, 在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltForImagesAndTextClassification 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import ViltProcessor, ViltForImagesAndTextClassification
>>> import requests
>>> from PIL import Image
>>> image1 = Image.open(requests.get("https://lil.nlp.cornell.edu/nlvr/exs/ex0_0.jpg", stream=True).raw)
>>> image2 = Image.open(requests.get("https://lil.nlp.cornell.edu/nlvr/exs/ex0_1.jpg", stream=True).raw)
>>> text = "The left image contains twice the number of dogs as the right image."
>>> processor = ViltProcessor.from_pretrained("dandelin/vilt-b32-finetuned-nlvr2")
>>> model = ViltForImagesAndTextClassification.from_pretrained("dandelin/vilt-b32-finetuned-nlvr2")
>>> # prepare inputs
>>> encoding = processor([image1, image2], text, return_tensors="pt")
>>> # forward pass
>>> outputs = model(input_ids=encoding.input_ids, pixel_values=encoding.pixel_values.unsqueeze(0))
>>> logits = outputs.logits
>>> idx = logits.argmax(-1).item()
>>> print("Predicted answer:", model.config.id2label[idx])
Predicted answer: TrueViltForImageAndTextRetrieval
class transformers.ViltForImageAndTextRetrieval
< source >( config )
参数
- config (ViltForImageAndTextRetrieval) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Vilt 模型 Transformer，顶部带有一个分类器头（在 [CLS] 标记的最终隐藏状态之上有一个线性层），用于图像到文本或文本到图像的检索，例如 MSCOCO 和 F30K。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的标记。
- pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size), 可选) — 对应于输入图像的张量。可以使用{image_processor_class}获取像素值。有关详细信息，请参阅{image_processor_class}.__call__（{processor_class}使用{image_processor_class}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), 可选) — 用于避免在填充像素值上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即被遮盖）。
- 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索引转换为关联向量，这将非常有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), 可选) — 可选地， вместо传递pixel_values，您可以选择直接传递嵌入式表示。如果您想更多地控制如何将pixel_values转换为补丁嵌入，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,), 可选) — 目前不支持标签。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltForImageAndTextRetrieval 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import ViltProcessor, ViltForImageAndTextRetrieval
>>> import requests
>>> from PIL import Image
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> texts = ["An image of two cats chilling on a couch", "A football player scoring a goal"]
>>> processor = ViltProcessor.from_pretrained("dandelin/vilt-b32-finetuned-coco")
>>> model = ViltForImageAndTextRetrieval.from_pretrained("dandelin/vilt-b32-finetuned-coco")
>>> # forward pass
>>> scores = dict()
>>> for text in texts:
... # prepare inputs
... encoding = processor(image, text, return_tensors="pt")
... outputs = model(**encoding)
... scores[text] = outputs.logits[0, :].item()ViltForTokenClassification
class transformers.ViltForTokenClassification
< source >( config )
参数
- config (ViltForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有一个标记分类头的 Vilt transformer（在隐藏状态输出之上有一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None pixel_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None image_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的标记。
- pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size), 可选) — 对应于输入图像的张量。可以使用{image_processor_class}获取像素值。有关详细信息，请参阅{image_processor_class}.__call__（{processor_class}使用{image_processor_class}处理图像）。 - pixel_mask (
torch.LongTensor，形状为(batch_size, height, width), 可选) — 用于避免在填充像素值上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示像素是真实的（即未被遮盖），
- 0 表示像素是填充的（即被遮盖）。
- 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索引转换为关联向量，这将非常有用。 - image_embeds (
torch.FloatTensor，形状为(batch_size, num_patches, hidden_size), 可选) — 可选地， вместо传递pixel_values，您可以选择直接传递嵌入式表示。如果您想更多地控制如何将pixel_values转换为补丁嵌入，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, text_sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ViltConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
ViltForTokenClassification 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在这个函数中定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ViltForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("dandelin/vilt-b32-mlm")
>>> model = ViltForTokenClassification.from_pretrained("dandelin/vilt-b32-mlm")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...