Transformers文档

可变形DETR

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

可变形DETR

概述

可变形DETR模型由Xizhou Zhu、Weijie Su、Lewei Lu、Bin Li、Xiaogang Wang和Jifeng Dai在论文《Deformable DETR: Deformable Transformers for End-to-End Object Detection》中提出,发表于arXiv。可变形DETR通过利用新的可变形注意力模块,该模块仅关注参考点周围的一小部分关键采样点,从而缓解了原始DETR的缓慢收敛问题和有限的特征空间分辨率。

论文的摘要如下

近期,DETR被提出用于消除物体检测中许多手工设计的组件,同时表现出良好的性能。然而,由于Transformer注意力模块在处理图像特征图方面的局限性,它遭受了收敛速度慢和特征空间分辨率有限的困扰。为了缓解这些问题,我们提出了可变形DETR,其注意力模块仅关注参考点周围的小组关键采样点。与DETR相比,可变形DETR在更少的训练周期(10倍更少)下能实现更好的性能(特别是在小物体上)。在各种COCO基准测试上的广泛实验验证了我们的方法的有效性。

绘图 可变形DETR架构。源自原始论文。(点击查看原始论文)

此模型由nielsr贡献。原始代码可在以下链接找到:此处

使用技巧

  • 训练可变形DETR相当于训练原始的DETR模型。以下是有关示例笔记本的资源部分。

资源

以下是一份官方的Hugging Face和社区(标记为🌍)资源列表,以帮助您开始使用可变形DETR。

物体检测

如果您有兴趣提交资源以在此处发布,请随时打开一个Pull Request,我们将对其进行审查!该资源应理想地展示新内容,而不是重复现有资源。

DeformableDetrImageProcessor

transformers.DeformableDetrImageProcessor

< >

( format: 联合 = <AnnotationFormat.COCO_DETECTION: 'coco_detection'> do_resize: 布尔 = True size: 字典 = None resample: 重采样 = <Resampling.BILINEAR: 2> do_rescale: 布尔 = True rescale_factor: 联合 = 0.00392156862745098 do_normalize: 布尔 = True image_mean: 联合 = None image_std: 联合 = None do_convert_annotations: 可选 = None do_pad: 布尔 = True pad_size: 可选 = None **kwargs )

参数

  • format (str, 可选, 默认为 "coco_detection") — 标注的数据格式。可以是“coco_detection”或“coco_panoptic”之一。
  • do_resize (bool, 可选, 默认为 True) — 控制是否将图像的(高度,宽度)维度调整到指定的 size。可以通过 preprocess 方法中的 do_resize 参数重写。
  • size (Dict[str, int] 可选, 默认为 {"shortest_edge" -- 800, "longest_edge": 1333}): 调整图像的(高度,宽度)维度后的尺寸。可以通过 preprocess 方法中的 size 参数重写。可用选项如下:
    • {"height": int, "width": int}: 图像将调整为确切的尺寸 (height, width)。不要保持宽高比。
    • {"shortest_edge": int, "longest_edge": int}: 图像将调整到最大尺寸,同时保持宽高比,并使最短边小于或等于 shortest_edge,最长边小于或等于 longest_edge
    • {"max_height": int, "max_width": int}: 图像将调整到最大尺寸,同时保持宽高比,并使高度小于或等于 max_height,宽度小于或等于 max_width
  • resample (PILImageResampling, 可选,默认为 PILImageResampling.BILINEAR) — 如果调整图像大小时要使用的重采样过滤器。
  • do_rescale (bool, 可选,默认为 True) — 控制是否使用指定的比例因子 rescale_factor 来调整图像大小。可以由 preprocess 方法中的 do_rescale 参数重写。
  • rescale_factor (intfloat, 可选,默认为 1/255) — 如果调整图像大小时要使用的比例因子。可以由 preprocess 方法中的 rescale_factor 参数重写。
  • image_mean (floatList[float]可选,默认为 IMAGENET_DEFAULT_MEAN) — 图像归一化时使用的均值。可以是单个值或值列表,每个通道一个值。可以被preprocess方法中的image_mean参数覆盖。
  • image_std (floatList[float]可选,默认为 IMAGENET_DEFAULT_STD) — 图像归一化时使用的标准差。可以是单个值或值列表,每个通道一个值。可以被preprocess方法中的image_std参数覆盖。
  • do_convert_annotations (bool可选,默认为 True) — 控制是否将注释转换为DETR模型期望的格式。将边界框转换为格式 (center_x, center_y, width, height) 并在范围 [0, 1] 内。可以被preprocess方法中的do_convert_annotations参数覆盖。
  • do_pad (bool, 可选, 默认为 True) — 控制是否对图像进行填充。可以在 preprocess 方法的 do_pad 参数中重写。如果为 True,则将在图像的底部和右边用零进行填充。如果提供了 pad_size,则图像将被填充到指定的尺寸。否则,图像将被填充到批量中的最大高度和宽度。
  • pad_size (Dict[str, int], 可选) — 填充图像的大小 {"height": int, "width" int}。必须大于预处理提供的任何图像尺寸。如果没有提供 pad_size,则图像将被填充到批次中的最大高度和宽度。

构建 Deformable DETR 图像处理器。

preprocess

< >

( images: 联集 annotations: 联集 = None return_segmentation_masks: bool = None masks_path: 联集 = None do_resize: Optional = None size: Optional = None resample = None do_rescale: Optional = None rescale_factor: 联集 = None do_normalize: Optional = None do_convert_annotations: Optional = None image_mean: 联集 = None image_std: 联集 = None do_pad: Optional = None format: 联集 = None return_tensors: 联集 = None data_format: 联集 = <ChannelDimension.FIRST: 'channels_first'> input_data_format: 联集 = None pad_size: Optional = None **kwargs )

参数

  • images (ImageInput) — 预处理前的图像或图像批量。期望输入像素值介于0到255的单个或图像批量。如果传递像素值介于0到1之间的图像,设置do_rescale=False
  • annotations (AnnotationTypeList[AnnotationType]可选) — 与图像或图像批量相关联的注释列表。如果注释是为了物体检测,则注释应包含以下键的字典:
    • “image_id” (int):图像id。
    • “annotations” (List[Dict]):图像的注释列表。每个注释应是一个字典。图像可以没有注释,在这种情况下列表应为空。如果注释是为了分割,则注释应包含以下键的字典:
    • “image_id” (int):图像id。
    • “segments_info” (List[Dict]):图像的分割列表。每个分割应是一个字典。图像可以没有分割,在这种情况下列表应为空。
    • “file_name” (str):图像的文件名。
  • return_segmentation_masks (bool可选,默认为self.return_segmentation_masks) — 是否返回分割掩码。
  • masks_path(《字符串》或《pathlib.Path》,可选)—— 包含分割蒙版的目录路径。
  • do_resize(《布尔型》,可选,默认为self.do_resize)—— 是否调整图像大小。
  • size(《字典[str, int]》,可选,默认为self.size)—— 调整后图像的(高度, 宽度)尺寸。可用选项包括:
    • {"height": int, "width": int}:图像将被调整为精确大小(高度, 宽度)。不要保持宽高比。
    • {"shortest_edge": int, "longest_edge": int}:图像将被调整到最大尺寸,同时保持宽高比,最短边不大于shortest_edge,最长边不大于longest_edge
    • {"max_height": int, "max_width": int}:图像将被调整到最大尺寸,同时保持宽高比,高度不大于max_height,宽度不大于max_width
  • resamplePILImageResampling可选,默认为 self.resample)—— 在调整图像大小时使用的重采样过滤器。
  • do_rescalebool可选,默认为 self.do_rescale)—— 是否重缩放图像。
  • rescale_factorfloat可选,默认为 self.rescale_factor)—— 重缩放图像时使用的缩放因子。
  • do_normalizebool可选,默认为 self.do_normalize)—— 是否标准化图像。
  • do_pad (bool, 可选,默认为 self.do_pad) — 是否对图像进行填充。如果为 True,将在图像底部和右侧用零填充。如果提供 pad_size,则将图像填充到指定的尺寸。否则,图像将填充到批次的最大高度和宽度。
  • format (strAnnotationFormat, 可选,默认为 self.format) — 标注的格式。
  • return_tensors (strTensorType, 可选,默认为 self.return_tensors) — 返回张量类型。如果为 None,将返回图像列表。
  • data_format (ChannelDimensionstr可选,默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • 未设置:使用输入图像的通道维度格式。
  • input_data_format (ChannelDimensionstr可选) — 输入图像的通道维度格式。如果未设置,则从输入图像中推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。
  • pad_size (Dict[str, int]可选) — 填充图像到指定的 {"height": int, "width" int} 大小。必须大于任何预处理提供的图像大小。如果未提供 pad_size,图像将被填充到批处理中的最大高度和宽度。

预处理图像或图像批次,以便模型可以使用。

post_process_object_detection

< >

( outputs threshold: float = 0.5 target_sizes: Union = None top_k: int = 100 ) List[Dict]

参数

  • outputs (DetrObjectDetectionOutput) — 模型的原始输出。
  • threshold (float, 可选) — 用于保持物体检测预测的分数阈值。
  • target_sizes (torch.TensorList[Tuple[int, int]],可选)—— 形状为 (batch_size, 2) 的 Tensor 或包含每个批次中图像目标尺寸(高度,宽度)的元组列表。如果设置为 None,则不调整预测的大小。
  • top_k (整型,可选,默认为 100)—— 在以阈值过滤之前,仅保留 top k 个边界框。

返回

列表[字典]

一个字典列表,每个字典包含由模型预测的批次中每个图像的分数、标签和边界框。

DeformableDetrForObjectDetection 的原始输出转换为最终的边界框格式(左上角 x, 左上角 y, 右下角 x, 右下角 y)。仅支持 PyTorch。

DeformableDetrFeatureExtractor

transformers.DeformableDetrFeatureExtractor

< >

( *参数 **关键字参数 )

__call__

< >

( images **关键字参数 )

预处理图像或图像批次。

post_process_object_detection

< >

( outputs threshold: float = 0.5 target_sizes: Union = None top_k: int = 100 ) List[Dict]

参数

  • outputs (DetrObjectDetectionOutput) —— 模型的原始输出。
  • threshold (float, 可选) —— 保留对象检测预测的得分阈值。
  • target_sizes (torch.TensorList[Tuple[int, int]], 可选) —— 形状为 (batch_size, 2) 的 Tensor 或包含每张图像目标大小(高度,宽度)的元组的列表。如果设置为 None,则预测不会被调整大小。
  • top_k (int, 可选, 默认为 100) —— 在阈值过滤之前仅保留前 k 个边界框。

返回

列表[字典]

一个字典列表,每个字典包含由模型预测的批次中每个图像的分数、标签和边界框。

DeformableDetrForObjectDetection 的原始输出转换为最终的边界框格式(左上角 x, 左上角 y, 右下角 x, 右下角 y)。仅支持 PyTorch。

DeformableDetrConfig

transformers.DeformableDetrConfig

< >

( use_timm_backbone = True backbone_config = None num_channels = 3 num_queries = 300 max_position_embeddings = 1024 encoder_layers = 6 encoder_ffn_dim = 1024 encoder_attention_heads = 8 decoder_layers = 6 decoder_ffn_dim = 1024 decoder_attention_heads = 8 encoder_layerdrop = 0.0 is_encoder_decoder = True activation_function = 'relu' d_model = 256 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 init_xavier_std = 1.0 return_intermediate = True auxiliary_loss = False position_embedding_type = 'sine' backbone = 'resnet50' use_pretrained_backbone = True backbone_kwargs = None dilation = False num_feature_levels = 4 encoder_n_points = 4 decoder_n_points = 4 two_stage = False two_stage_num_proposals = 300 with_box_refine = False class_cost = 1 bbox_cost = 5 giou_cost = 2 mask_loss_coefficient = 1 dice_loss_coefficient = 1 bbox_loss_coefficient = 5 giou_loss_coefficient = 2 eos_coefficient = 0.1 focal_alpha = 0.25 disable_custom_kernels = False **kwargs )

参数

  • use_timm_backbone (bool, 可选, 默认为 True) — 是否使用 timm 库作为主干。如果设置为 False,将使用 AutoBackbone API。
  • backbone_config (PretrainedConfigdict,可选)—— 背骨模型的配置。仅在将 use_timm_backbone 设置为 False 时使用,默认值为 ResNetConfig()
  • num_channels (int,可选,默认为 3)—— 输入通道数。
  • num_queries (int,可选,默认为 300)—— 物体查询数,即检测槽位。这是 DeformableDetrModel 在单个图像中可以检测到的最大物体数。如果将 two_stage 设置为 True,则使用 two_stage_num_proposals
  • d_model (int, 可选,默认为 256) — 层数的维度。
  • encoder_layers (int, 可选,默认为 6) — 编码器层数量。
  • decoder_layers (int, 可选,默认为 6) — 解码器层数量。
  • encoder_attention_heads (int, 可选,默认为 8) — Transformer编码器中每个注意力层的注意力头数量。
  • decoder_attention_heads (int, 可选, 默认为8) — Transformer解码器中每一层的注意力头的数量。
  • decoder_ffn_dim (int, 可选, 默认为1024) — 解码器中“中间”(通常称为前馈)层的维度。
  • encoder_ffn_dim (int, 可选, 默认为1024) — 解码器中“中间”(通常称为前馈)层的维度。
  • activation_function (strfunction, 可选, 默认为 "relu") — 编码器和pooler中的非线性激活函数(函数或字符串)。如果为字符串,支持 "gelu""relu""silu""gelu_new"
  • dropout (float, 可选,默认为0.1) — 所有嵌入层、编码器池化层的dropout概率。
  • attention_dropout (float, 可选,默认为0.0) — 注意力概率的dropout比例。
  • activation_dropout (float, 可选,默认为0.0) — 完全连接层内部激活的dropout比例。
  • init_std (float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 标准差。
  • init_xavier_std (float, 可选, 默认值为 1) — 汉密尔顿注意图模块中用于 Xavier 初始化的缩放因子。
  • encoder_layerdrop (float, 可选, 默认值为 0.0) — 编码器的 LayerDrop 概率。详见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556) 以获取更多详细信息。
  • 辅助损失 (bool可选,默认为 False) — 是否使用辅助解码损失(在每个解码层中的损失)。
  • position_embedding_type (str可选,默认为 "sine") — 在图像特征之上使用的定位嵌套类型。可选 "sine""learned"
  • backbone (str可选,默认为 "resnet50") — 当 backbone_configNone 时使用的主体架构名称。如果 use_pretrained_backboneTrue,则从 timm 或 transformers 库中加载相应的预训练权重。如果 use_pretrained_backboneFalse,则加载主体架构的配置,并用随机权重初始化主体架构。
  • use_pretrained_backbone (bool, 可选, 默认为 True) — 是否使用预训练的骨干网络权重。
  • backbone_kwargs (dict, 可选) — 加载检查点时传递给AutoBackbone的键值参数,例如 {'out_indices': (0, 1, 2, 3)}。如果设置了 backbone_config,则不能指定。
  • dilation (bool, 可选, 默认为 False) — 是否在最后一个卷积块 (DC5) 中将步幅替换为膨胀率。仅在 use_timm_backbone = True 时受支持。
  • class_cost (float, 可选, 默认为 1) — 匈牙利匹配成本中分类错误的相对权重。
  • bbox_cost (浮点型, 可选, 默认值为5) — 在匈牙利匹配成本中,边界框坐标L1错误的相对权重。
  • giou_cost (浮点型, 可选, 默认值为2) — 在匈牙利匹配成本中,边界框的广义IoU损失的相对权重。
  • mask_loss_coefficient (浮点型, 可选, 默认值为1) — 在全解分割损失中,Focal损失的相对权重。
  • dice_loss_coefficient (浮点型, 可选, 默认值为1) — 在全解分割损失中,DICE/F-1损失的相对权重。
  • bbox_loss_coefficientfloat,可选,默认为5)——在目标检测损失中L1边界框损失的相对权重。
  • giou_loss_coefficientfloat,可选,默认为2)——在目标检测损失中广义IoU损失的相对权重。
  • eos_coefficientfloat,可选,默认为0.1)——在目标检测损失中‘无物体’类别的相对分类权重。
  • num_feature_levelsint,可选,默认为4)——输入特征层数。
  • encoder_n_points (int, 可选,默认为 4) — 编码器中每个注意力头在每个特征级别的采样密钥数量。
  • decoder_n_points (int, 可选,默认为 4) — 解码器中每个注意力头在每个特征级别的采样密钥数量。
  • two_stage (bool, 可选,默认为 False) — 是否应用双阶段可变形 DETR,其中区域提议也由可变形 DETR 的变体生成,进一步馈送到解码器中进行迭代边界框细化。
  • two_stage_num_proposalsint,可选,默认为300)—— 当two_stage设置为True时,生成的区域候选框的数量。
  • with_box_refinebool,可选,默认为False)—— 是否应用迭代边界框细化,每个解码器层根据前一层的预测细化边界框。
  • focal_alphafloat,可选,默认为0.25)—— 愚光损失的Alpha参数。
  • disable_custom_kernels (bool, 可选, 默认为 False) — 禁用自定义CUDA和CPU内核的使用。此选项对于ONNX导出是必要的,因为PyTorch ONNX导出不支持自定义内核。

这是存储DeformableDetrModel配置的配置类。它用于根据指定的参数实例化Deformable DETR模型,定义模型架构。使用默认值实例化配置将产生与Deformable DETR SenseTime/deformable-detr架构相似的配置。

配置对象继承自PretrainedConfig,并可用于控制模型输出。更多详细信息,请参阅PretrainedConfig文档。

示例

>>> from transformers import DeformableDetrConfig, DeformableDetrModel

>>> # Initializing a Deformable DETR SenseTime/deformable-detr style configuration
>>> configuration = DeformableDetrConfig()

>>> # Initializing a model (with random weights) from the SenseTime/deformable-detr style configuration
>>> model = DeformableDetrModel(configuration)

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

DeformableDetrModel

class transformers.DeformableDetrModel

< >

( config)

参数

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

裸Deformable DETR模型(由骨干和编码器-解码器Transformer组成),输出原始隐藏状态,且顶部没有任何特定头部。

该模型继承自PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入、剪枝头部等)。

该模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch Module使用,并参考PyTorch文档了解所有与通用使用和行为相关的事项。

forward

< >

( pixel_values: FloatTensor pixel_mask: 任意 = None decoder_attention_mask: 任意 = None encoder_outputs: 任意 = None inputs_embeds: 任意 = None decoder_inputs_embeds: 任意 = None output_attentions: 任意 = None output_hidden_states: 任意 = None return_dict: 任意 = None ) transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状 (batch_size, num_channels, height, width)) — 像素值。默认情况下,如果提供了填充值,将忽略填充。
  • pixel_mask (torch.LongTensor 形状 (batch_size, height, width)可选) — 用于避免在填充像素值上执行注意力的掩码。掩码值选择在 [0, 1]
    • 1 对于实际像素(即未掩码),
    • 0 对于填充像素(即掩码)。

    注意力掩码是什么?

  • decoder_attention_mask (torch.FloatTensor 形状为 (batch_size, num_queries)可选)— 默认情况下未使用。可用于屏蔽对象查询。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)可选)— Tuple 包含 last_hidden_state可选: hidden_states可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size)可选)是编码器最后层输出的隐藏状态序列。用于解码器的交叉注意力。
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选)— 可选地,你可以直接传递图像的扁平表示(而不是通过骨架网络 + 投影层的平坦特征图),而不是传递展开的特征图。
  • decoder_inputs_embeds (torch.FloatTensordimensions(batch_size, num_queries, hidden_size),可选)— 可以选择不使用零张量初始化查询,而是直接传递嵌入表示。
  • output_attentions (bool,可选)— 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool,可选)— 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。

返回

transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrModelOutputtuple(torch.FloatTensor)

一个transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrModelOutput,或者一个torch.FloatTensor的元组(如果传递了return_dict=False或者当配置文件config.return_dict=False时),包含根据配置(如DeformableDetrConfig)和输入确定的各种元素。

  • init_reference_points (torch.FloatTensor形状为(batch_size, num_queries, 4)) — 通过Transformer解码器发送的初始参考点。
  • last_hidden_state (torch.FloatTensor形状为(batch_size, num_queries, hidden_size)) — 模型解码器最后一个层次的输出处的隐藏状态序列。
  • intermediate_hidden_states (torch.FloatTensor形状为(batch_size, decoder_layers, num_queries, hidden_size)) — 堆叠的中间隐藏状态(解码器每一层的输出)。
  • intermediate_reference_points (torch.FloatTensor形状为(batch_size, decoder_layers, num_queries, 4)) — 堆叠的中间参考点(解码器每一层的参考点)。
  • decoder_hidden_states (tuple(torch.FloatTensor),可选,在传递了output_hidden_states=True或当配置文件config.output_hidden_states=True时返回) — 一个由形状为(batch_size, num_queries, hidden_size)torch.FloatTensor组成的元组(一个用于嵌入输出,一个用于每层的输出)。解码器在每个层次输出后的隐藏状态以及初始嵌入输出。
  • decoder_attentions (tuple(torch.FloatTensor),可选,在传递了output_attentions=True或当配置文件config.output_attentions=True时返回) — 一个形状为(batch_size, num_heads, num_queries, num_queries)torch.FloatTensor的元组(每层一个)。解码器在关注softmax后的注意力权重,用于在自注意力头中计算加权平均。
  • cross_attentions (tuple(torch.FloatTensor),可选,在传递了output_attentions=True或当配置文件config.output_attentions=True时返回) — 一个形状为(batch_size, num_queries, num_heads, 4, 4)torch.FloatTensor的元组(每层一个)。解码器交叉注意力层的注意力权重,在注意力softmax后使用,用于在交叉注意力头中计算加权平均。
  • encoder_last_hidden_state (torch.FloatTensor形状为(batch_size, sequence_length, hidden_size),可选) — 模型编码器最后一个层次的输出处的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor),可选,在传递了output_hidden_states=True或当配置文件config.output_hidden_states=True时返回) — 一个由形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor组成的元组(一个用于嵌入输出,一个用于每层的输出)。编码器在每个层次输出后的隐藏状态以及初始嵌入输出。
  • encoder_attentions (torch.FloatTensor的tuple, 可选, 当传入output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor元组(表征形状为(batch_size, num_queries, num_heads, 4, 4))。编码器注意力权重,在注意力softmax之后,用于在自注意力头中进行加权平均。
  • enc_outputs_class (形状为(batch_size, sequence_length, config.num_labels)的torch.FloatTensor, 可选, 当config.with_box_refine=Trueconfig.two_stage=True时返回) — 在第一阶段中选取前config.two_stage_num_proposals个得分最高的边界框作为区域候选的预测边界框得分。边界框二分类输出(即前景和背景)。
  • enc_outputs_coord_logits (形状为(batch_size, sequence_length, 4)的torch.FloatTensor, 可选, 当config.with_box_refine=Trueconfig.two_stage=True时返回) — 第一阶段中预测边界框坐标的对数似然。

DeformableDetrModel正向方法,覆盖了特殊方法__call__

尽管正向传递的配方需要在函数内部定义,但应调用此函数之后的Module实例,而不是此函数本身,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略了它们。

示例

>>> from transformers import AutoImageProcessor, DeformableDetrModel
>>> from PIL import Image
>>> import requests

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> image_processor = AutoImageProcessor.from_pretrained("SenseTime/deformable-detr")
>>> model = DeformableDetrModel.from_pretrained("SenseTime/deformable-detr")

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

>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 300, 256]

DeformableDetrForObjectDetection

class transformers.DeformableDetrForObjectDetection

< >

( config)

参数

  • 配置 (DeformableDetrConfig) — 包含模型所有参数的配置类。使用配置文件初始化时不会加载模型相关的权重,只有配置本身。查看 from_pretrained() 方法以加载模型权重。

Deformable DETR 模型(由骨架网络和编码器-解码器 Transformer 构成)在顶部有目标检测头,用于如 COCO 检测等任务。

该模型继承自PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入、剪枝头部等)。

该模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch Module使用,并参考PyTorch文档了解所有与通用使用和行为相关的事项。

forward

< >

( pixel_values: FloatTensor pixel_mask: Optional = None decoder_attention_mask: Optional = None encoder_outputs: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrObjectDetectionOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) —— 像素值。如果提供填充,则默认忽略填充。

  • pixel_mask (torch.LongTensor 形状为 (batch_size, height, width)可选) —— 用于避免在填充像素值上执行注意力的掩码。掩码值选择在 [0, 1] 之间:

  • decoder_attention_mask (torch.FloatTensor 形状为 (batch_size, num_queries)可选) —— 默认情况下未使用。可以用来屏蔽物体查询。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)可选) —— 包含 (last_hidden_state可选: hidden_states可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size)可选) 是编码器最后层输出的隐藏状态序列。用于解码器的交叉注意力。
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) —— 可选地,您可以直接传递图像的展平表示,而不是传递平展的特征图(骨干层+投影层的输出)。
  • decoder_inputs_embeds (torch.FloatTensor 的形状为 (batch_size, num_queries, hidden_size)可选) — 可选地,用零的tensor初始化queries而不是直接传递嵌入式表示。
  • output_attentions (bool可选) — 是否返回所有注意力层的所有注意力张量。请参见返回中的 attentions 获取更多详细信息。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。请参见返回中的 hidden_states 获取更多详细信息。
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • labels (List[Dict] of len (batch_size,), optional) — 计算二分匹配损失的标签。字典列表,每个字典至少包含以下2个键:‘class_labels’和‘boxes’(批量中图像的类别标签和边界框)。类别标签本身应为len (number of bounding boxes in the image,)torch.LongTensor,而边界框为torch.FloatTensor,形状为(number of bounding boxes in the image, 4)

返回

transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrObjectDetectionOutputtuple(torch.FloatTensor)

一个 transformers.models.deformable_detr.modeling_deformable_detr.DeformableDetrObjectDetectionOutput 或一个包含各种元素的元组,这些元素取决于配置(DeformableDetrConfig)和输入的torch.FloatTensor(如果传递了return_dict=False或当config.return_dict=False时)。

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels are provided)) — 总损失是类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为L1损失和广义尺度不变IoU损失的线性组合。
  • loss_dict (Dict, optional) — 包含个别损失的字典。用于记录。
  • logits (torch.FloatTensor of shape (batch_size, num_queries, num_classes + 1)) — 所有查询的分类logits(包括没有目标)。
  • pred_boxes (torch.FloatTensor of shape (batch_size, num_queries, 4)) — 所有查询的归一化边界框坐标,表示为(中心_x,中心_y,宽度,高度)。这些值在[0, 1]范围内归一化,相对于批量中每个图像的大小(不考虑可能的填充)。您可以使用~DeformableDetrProcessor.post_process_object_detection检索未归一化的边界框。
  • auxiliary_outputs (list[Dict], optional) — 可选的,只在激活辅助损失(即config.auxiliary_loss设置为True)并提供标签时返回。它是一个列表,其中包含每个解码层上述两个键(logitspred_boxes)的字典。
  • last_hidden_state (torch.FloatTensor of shape (batch_size, num_queries, hidden_size), optional) — 模型解码器最后层的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor),可选,在传递了output_hidden_states=True或当配置文件config.output_hidden_states=True时返回) — 一个由形状为(batch_size, num_queries, hidden_size)torch.FloatTensor组成的元组(一个用于嵌入输出,一个用于每层的输出)。解码器在每个层次输出后的隐藏状态以及初始嵌入输出。
  • decoder_attentions (tuple(torch.FloatTensor),可选,在传递了output_attentions=True或当配置文件config.output_attentions=True时返回) — 一个形状为(batch_size, num_heads, num_queries, num_queries)torch.FloatTensor的元组(每层一个)。解码器在关注softmax后的注意力权重,用于在自注意力头中计算加权平均。
  • cross_attentions (tuple(torch.FloatTensor),可选,在传递了output_attentions=True或当配置文件config.output_attentions=True时返回) — 一个形状为(batch_size, num_queries, num_heads, 4, 4)torch.FloatTensor的元组(每层一个)。解码器交叉注意力层的注意力权重,在注意力softmax后使用,用于在交叉注意力头中计算加权平均。
  • encoder_last_hidden_state (torch.FloatTensor形状为(batch_size, sequence_length, hidden_size),可选) — 模型编码器最后一个层次的输出处的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor),可选,在传递了output_hidden_states=True或当配置文件config.output_hidden_states=True时返回) — 一个由形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor组成的元组(一个用于嵌入输出,一个用于每层的输出)。编码器在每个层次输出后的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 元组,包含每个层的torch.FloatTensor(每个层一个),形状为(batch_size, sequence_length, num_heads, 4, 4)。编码器的注意力权重,在注意力softmax后将用于计算自我注意力头中的加权平均。
  • intermediate_hidden_states (torch.FloatTensor形状为(batch_size, decoder_layers, num_queries, hidden_size)) — 堆叠的中间隐藏状态(解码器每一层的输出)。
  • intermediate_reference_points (torch.FloatTensor形状为(batch_size, decoder_layers, num_queries, 4)) — 堆叠的中间参考点(解码器每一层的参考点)。
  • init_reference_points (torch.FloatTensor形状为(batch_size, num_queries, 4)) — 通过Transformer解码器发送的初始参考点。
  • enc_outputs_class (形状为(batch_size, sequence_length, config.num_labels)的torch.FloatTensor, 可选, 当config.with_box_refine=Trueconfig.two_stage=True时返回) — 在第一阶段中选取前config.two_stage_num_proposals个得分最高的边界框作为区域候选的预测边界框得分。边界框二分类输出(即前景和背景)。
  • enc_outputs_coord_logits (形状为(batch_size, sequence_length, 4)的torch.FloatTensor, 可选, 当config.with_box_refine=Trueconfig.two_stage=True时返回) — 第一阶段中预测边界框坐标的对数似然。

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

尽管正向传递的配方需要在函数内部定义,但应调用此函数之后的Module实例,而不是此函数本身,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略了它们。

示例

>>> from transformers import AutoImageProcessor, DeformableDetrForObjectDetection
>>> from PIL import Image
>>> import requests

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> image_processor = AutoImageProcessor.from_pretrained("SenseTime/deformable-detr")
>>> model = DeformableDetrForObjectDetection.from_pretrained("SenseTime/deformable-detr")

>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)

>>> # convert outputs (bounding boxes and class logits) to Pascal VOC format (xmin, ymin, xmax, ymax)
>>> target_sizes = torch.tensor([image.size[::-1]])
>>> results = image_processor.post_process_object_detection(outputs, threshold=0.5, target_sizes=target_sizes)[
...     0
... ]
>>> for score, label, box in zip(results["scores"], results["labels"], results["boxes"]):
...     box = [round(i, 2) for i in box.tolist()]
...     print(
...         f"Detected {model.config.id2label[label.item()]} with confidence "
...         f"{round(score.item(), 3)} at location {box}"
...     )
Detected cat with confidence 0.8 at location [16.5, 52.84, 318.25, 470.78]
Detected cat with confidence 0.789 at location [342.19, 24.3, 640.02, 372.25]
Detected remote with confidence 0.633 at location [40.79, 72.78, 176.76, 117.25]
< > 在GitHub上更新