Hugging Face 的 logo

Transformers 文档

DETR

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验的权限

开始使用

DETR

概述

DETR 模型是由 Nicolas Carion、Francisco Massa、Gabriel Synnaeve、Nicolas Usunier、Alexander Kirillov 和 Sergey Zagoruyko 在 基于 Transformer 的端到端目标检测 一文中提出的。DETR 由一个卷积骨干网络和一个编码器-解码器 Transformer 组成，可以进行端到端的训练以进行目标检测。它大大简化了 Faster-R-CNN 和 Mask-R-CNN 等模型的复杂性，这些模型使用了区域建议、非极大值抑制过程和锚点生成等方法。此外，通过简单地在解码器输出之上添加一个掩码头，DETR 还可以自然地扩展到执行全景分割。

论文的摘要是这样的

我们提出了一种将目标检测视为直接集合预测问题的新方法。我们的方法简化了检测流程，有效地消除了对许多手工设计的组件的需求，例如非极大值抑制过程或锚点生成，这些组件明确编码了我们对任务的先验知识。这个名为 DEtection TRansformer 或 DETR 的新框架的主要组成部分是一个基于集合的全局损失函数，它通过二分匹配强制进行唯一预测，以及一个 Transformer 编码器-解码器架构。给定一组固定的学习到的少量目标查询，DETR 推理目标之间的关系和全局图像上下文，以直接并行输出最终的预测集。与许多其他现代检测器不同，新模型在概念上很简单，并且不需要专门的库。在具有挑战性的 COCO 目标检测数据集上，DETR 的准确性和运行时性能与完善且高度优化的 Faster RCNN 基线相当。此外，DETR 可以很容易地以统一的方式推广到生成全景分割。我们证明，它明显优于竞争基线。

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

DETR 的工作原理

以下是解释 DetrForObjectDetection 工作原理的简要说明

首先，将图像发送到预训练的卷积骨干网络（在论文中，作者使用 ResNet-50/ResNet-101）。假设我们还添加了一个批处理维度。这意味着骨干网络的输入是一个形状为 (batch_size, 3, height, width) 的张量，假设图像有 3 个颜色通道（RGB）。CNN 骨干网络输出一个新的低分辨率特征图，通常形状为 (batch_size, 2048, height/32, width/32)。然后使用 nn.Conv2D 层将其投影以匹配 DETR 的 Transformer 的隐藏维度，默认情况下为 256。所以现在，我们有一个形状为 (batch_size, 256, height/32, width/32) 的张量。接下来，对特征图进行展平和转置，以获得形状为 (batch_size, seq_len, d_model) = (batch_size, width/32*height/32, 256) 的张量。因此，与 NLP 模型的区别在于，序列长度实际上比平常更长，但 d_model 更小（NLP 中通常为 768 或更大）。

接下来，将其发送到编码器，输出相同形状的 encoder_hidden_states（您可以将其视为图像特征）。接下来，将所谓的**目标查询**发送到解码器。这是一个形状为 (batch_size, num_queries, d_model) 的张量，其中 num_queries 通常设置为 100 并初始化为零。这些输入嵌入是作者称为目标查询的学习到的位置编码，与编码器类似，它们被添加到每个注意力层的输入中。每个目标查询都将在图像中查找特定目标。解码器通过多个自注意力和编码器-解码器注意力层更新这些嵌入，以输出相同形状的 decoder_hidden_states：(batch_size, num_queries, d_model)。接下来，在顶部添加两个头用于目标检测：一个线性层，用于将每个目标查询分类为一个目标或“无目标”，以及一个 MLP，用于预测每个查询的边界框。

使用**二分匹配损失**训练模型：因此，我们实际上要做的是将 N = 100 个目标查询中的每一个的预测类别 + 边界框与填充到相同长度 N 的真实注释进行比较（因此，如果图像仅包含 4 个目标，则 96 个注释将仅具有“无目标”作为类别，“无边界框”作为边界框）。匈牙利匹配算法用于找到 N 个查询中的每一个与 N 个注释中的每一个之间的一对一最佳映射。接下来，使用标准交叉熵（用于类别）以及 L1 和 广义 IoU 损失 的线性组合（用于边界框）来优化模型参数。

DETR 可以自然地扩展到执行全景分割（它统一了语义分割和实例分割）。DetrForSegmentation 在 DetrForObjectDetection 的基础上添加了一个分割掩码头。掩码头可以联合训练，也可以分两步训练，首先训练一个 DetrForObjectDetection 模型来检测“事物”（实例）和“东西”（如树木、道路、天空等背景事物）周围的边界框，然后冻结所有权重，只训练掩码头 25 个 epoch。实验表明，这两种方法的结果相似。请注意，预测边界框是训练的必要条件，因为匈牙利匹配是使用边界框之间的距离计算的。

使用技巧

  • DETR 使用所谓的**对象查询**来检测图像中的对象。查询的数量决定了可以在单个图像中检测到的最大对象数量，默认设置为 100（请参阅 DetrConfig 的参数 num_queries）。请注意，最好留一些余量（在 COCO 中，作者使用 100，而 COCO 图像中的最大对象数量约为 70）。
  • DETR 的解码器并行更新查询嵌入。这与 GPT-2 等使用自回归解码而不是并行解码的语言模型不同。因此，不使用因果注意力掩码。
  • 在投影到查询和键之前，DETR 在每个自注意力和交叉注意力层的隐藏状态中添加了位置嵌入。对于图像的位置嵌入，可以选择固定的正弦或学习的绝对位置嵌入。默认情况下，DetrConfig 的参数 position_embedding_type 设置为 "sine"。
  • 在训练过程中，DETR 的作者确实发现使用解码器中的辅助损失很有帮助，特别是帮助模型输出每个类的正确对象数量。如果将 DetrConfig 的参数 auxiliary_loss 设置为 True，则在每个解码器层之后添加预测前馈神经网络和匈牙利损失（FFN 共享参数）。
  • 如果要在多个节点的分布式环境中训练模型，则应更新 modeling_detr.py 的 DetrLoss 类中的 num_boxes 变量。在多个节点上训练时，应将其设置为所有节点的目标框的平均数量，如原始实现中所示 此处。
  • 可以使用 timm 库 中可用的任何卷积骨干来初始化 DetrForObjectDetection 和 DetrForSegmentation。例如，可以通过将 DetrConfig 的 backbone 属性设置为 "tf_mobilenetv3_small_075"，然后使用该配置初始化模型来使用 MobileNet 骨干进行初始化。
  • DETR 会调整输入图像的大小，使最短边至少达到一定像素数，而最长边最多为 1333 像素。在训练时，使用缩放增强，使最短边随机设置为至少 480 像素，最多 800 像素。在推理时，最短边设置为 800 像素。可以使用 DetrImageProcessor 为模型准备图像（以及 COCO 格式的可选注释）。由于这种大小调整，批次中的图像可能具有不同的大小。DETR 通过将图像填充到批次中的最大大小，并创建一个像素掩码来解决这个问题，该掩码指示哪些像素是真实的，哪些是填充的。或者，也可以定义一个自定义的 collate_fn，以便使用 ~transformers.DetrImageProcessor.pad_and_create_pixel_mask 将图像批处理在一起。
  • 图像的大小将决定使用的内存量，从而决定 batch_size。建议每个 GPU 使用 2 的批次大小。有关更多信息，请参阅 此 Github 主题。

有三种方法可以实例化 DETR 模型（取决于您的偏好）

选项 1：使用整个模型的预训练权重实例化 DETR

>>> from transformers import DetrForObjectDetection

>>> model = DetrForObjectDetection.from_pretrained("facebook/detr-resnet-50")

选项 2：使用随机初始化的 Transformer 权重实例化 DETR，但使用预训练的骨干权重

>>> from transformers import DetrConfig, DetrForObjectDetection

>>> config = DetrConfig()
>>> model = DetrForObjectDetection(config)

选项 3：使用随机初始化的骨干 + Transformer 权重实例化 DETR

>>> config = DetrConfig(use_pretrained_backbone=False)
>>> model = DetrForObjectDetection(config)

总而言之，请考虑下表

任务 目标检测 实例分割 全景分割
描述 预测图像中物体周围的边界框和类别标签 预测图像中物体（即实例）周围的掩码 预测图像中物体（即实例）以及“东西”（即树木和道路等背景事物）周围的掩码
模型 DetrForObjectDetection DetrForSegmentation DetrForSegmentation
示例数据集 COCO 检测 COCO 检测、COCO 全景 COCO 全景
**提供给 DetrImageProcessor 的注释格式** {‘image_id’: int, ‘annotations’: List[Dict]} 每个 Dict 都是一个 COCO 对象注释 {‘image_id’: int, ‘annotations’: List[Dict]}（如果是 COCO 检测）或 {‘file_name’: str, ‘image_id’: int, ‘segments_info’: List[Dict]}（如果是 COCO 全景） {‘file_name’: str, ‘image_id’: int, ‘segments_info’: List[Dict]} 和 masks_path（包含掩码 PNG 文件的目录的路径）
**后处理**（即将模型的输出转换为 Pascal VOC 格式） post_process() post_process_segmentation() post_process_segmentation(), post_process_panoptic()
评估器 CocoEvaluator，使用 iou_types="bbox" CocoEvaluator，使用 iou_types="bbox" 或 "segm" CocoEvaluator，使用 iou_tupes="bbox" 或 "segm"，PanopticEvaluator

简而言之，应该以 COCO 检测或 COCO 全景格式准备数据，然后使用 DetrImageProcessor 创建 pixel_values、pixel_mask 和可选的 labels，然后可以使用它们来训练（或微调）模型。对于评估，应该首先使用 DetrImageProcessor 的后处理方法之一转换模型的输出。可以将这些提供给 CocoEvaluator 或 PanopticEvaluator，这使您可以计算平均精度均值 (mAP) 和全景质量 (PQ) 等指标。后一种对象在 原始存储库 中实现。有关评估的更多信息，请参阅 示例笔记本。

资源

一份官方 Hugging Face 和社区 (🌎 表示) 资源列表，帮助您开始使用 DETR。

目标检测

如果您有兴趣提交资源以包含在此处，请随时打开拉取请求，我们会进行审核！理想情况下，该资源应该展示一些新内容，而不是重复现有的资源。

DetrConfig

类 transformers.DetrConfig

< >

( use_timm_backbone = True backbone_config = None num_channels = 3 num_queries = 100 encoder_layers = 6 encoder_ffn_dim = 2048 encoder_attention_heads = 8 decoder_layers = 6 decoder_ffn_dim = 2048 decoder_attention_heads = 8 encoder_layerdrop = 0.0 decoder_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 auxiliary_loss = False position_embedding_type = 'sine' backbone = 'resnet50' use_pretrained_backbone = True backbone_kwargs = None dilation = 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 **kwargs )

参数

  • use_timm_backbone (bool, 可选, 默认为 True) — 是否使用 timm 库作为骨干网络。如果设置为 False，将使用 AutoBackbone API。
  • backbone_config (PretrainedConfig 或 dict, 可选) — 骨干模型的配置。仅在 use_timm_backbone 设置为 False 时使用，在这种情况下它将默认为 ResNetConfig()。
  • num_channels (int, 可选, 默认为 3) — 输入通道的数量。
  • num_queries (int, 可选, 默认值: 100) — 对象查询的数量，即检测槽。这是 DetrModel 在单张图像中可以检测到的最大对象数量。对于 COCO，我们建议使用 100 个查询。
  • 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, 可选, 默认值: 2048) — 解码器中“中间”（通常称为前馈）层的维度。
  • encoder_ffn_dim (int, 可选, 默认值: 2048) — 解码器中“中间”（通常称为前馈）层的维度。
  • activation_function (str 或 function, *可选*, 默认值为 "relu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "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) — 用于 HM 注意力图模块中 Xavier 初始化增益的缩放因子。
  • encoder_layerdrop (float, *可选*, 默认值为 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://arxiv.org/abs/1909.11556)。
  • decoder_layerdrop (float，可选，默认为 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](请参阅 https://arxiv.org/abs/1909.11556)。
  • auxiliary_loss (bool，可选，默认为 False) — 是否使用辅助解码损失（每个解码器层的损失）。
  • position_embedding_type (str，可选，默认为 "sine") — 要在图像特征之上使用的位置嵌入类型。一个是 "sine" 或 "learned"。
  • backbone (str，可选，默认为 "resnet50") — 当 backbone_config 为 None 时要使用的骨干网络名称。如果 use_pretrained_backbone 为 True，这将从 timm 或 transformers 库加载相应的预训练权重。如果 use_pretrained_backbone 为 False，这将加载骨干网络的配置，并使用它来初始化具有随机权重的骨干网络。
  • 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 (float，可选，默认为 5) — 匈牙利匹配成本中边界框坐标的 L1 误差的相对权重。
  • giou_cost (float，可选，默认为 2) — 匈牙利匹配成本中边界框的广义 IoU 损失的相对权重。
  • mask_loss_coefficient (float，可选，默认为 1) — 全景分割损失中 Focal 损失的相对权重。
  • dice_loss_coefficient (float，可选，默认为 1) — 全景分割损失中 DICE/F-1 损失的相对权重。
  • bbox_loss_coefficient (float，可选，默认为 5) — 目标检测损失中 L1 边界框损失的相对权重。
  • giou_loss_coefficient (float，可选，默认为 2) — 目标检测损失中广义 IoU 损失的相对权重。
  • eos_coefficient (float，可选，默认为 0.1) — 目标检测损失中“无目标”类的相对分类权重。

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

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

例子

>>> from transformers import DetrConfig, DetrModel

>>> # Initializing a DETR facebook/detr-resnet-50 style configuration
>>> configuration = DetrConfig()

>>> # Initializing a model (with random weights) from the facebook/detr-resnet-50 style configuration
>>> model = DetrModel(configuration)

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

from_backbone_config

< >

( backbone_config: PretrainedConfig **kwargs ) → DetrConfig

参数

  • backbone_config (PretrainedConfig) — 主干网络配置。

返回

DetrConfig

配置对象的一个实例

从预训练的主干网络模型配置实例化一个 DetrConfig （或其派生类）。

DetrImageProcessor

类 transformers.DetrImageProcessor

< >

( format: Union = <AnnotationFormat.COCO_DETECTION: 'coco_detection'> do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = None do_convert_annotations: Optional = None do_pad: bool = True pad_size: Optional = None **kwargs )

参数

  • format (str, 可选, 默认值为 "coco_detection") — 标注的数据格式。可以是 “coco_detection” 或 “coco_panoptic”。
  • do_resize (bool，可选，默认为 True) — 控制是否将图像的 (height, width) 尺寸调整为指定的 size。可以在 preprocess 方法中使用 do_resize 参数覆盖。
  • size (Dict[str, int]，可选，默认为 {"shortest_edge" -- 800, "longest_edge": 1333}): 调整大小后图像 (height, width) 尺寸的大小。 可以在 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 (int 或 float，可选，默认为 1/255) — 重新缩放图像时使用的缩放因子。可以在 preprocess 方法中使用 rescale_factor 参数覆盖。
  • do_normalize (bool，可选，默认为 True) — 控制是否对图像进行归一化。可以在 preprocess 方法中使用 do_normalize 参数覆盖。
  • image_mean (float 或 List[float], 可选, 默认为 IMAGENET_DEFAULT_MEAN) — 归一化图像时使用的均值。可以是单个值或值列表，每个通道一个值。可以通过 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (float 或 List[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，则图像将被填充到批处理中的最大高度和宽度。

构造一个 Detr 图像处理器。

预处理

< >

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

参数

  • images (ImageInput) — 需要预处理的图像或图像批次。期望像素值范围为 0 到 255 的单个或一批图像。如果传入像素值介于 0 和 1 之间的图像，请设置 do_rescale=False。
  • annotations (AnnotationType 或 List[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 (str 或 pathlib.Path，可选) — 包含分割掩码的目录的路径。
  • do_resize (bool，*可选*，默认为 self.do_resize) — 是否调整图像大小。
  • size (Dict[str, int]，*可选*，默认为 self.size) — 调整大小后图像 (height, width) 维度的尺寸。可用选项有：
    • {"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，*可选*，默认为 self.resample) — 调整图像大小使用的重采样滤波器。
  • do_rescale (bool，*可选*，默认为 self.do_rescale) — 是否重新缩放图像。
  • rescale_factor (float，*可选*，默认为 self.rescale_factor) — 重新缩放图像时使用的缩放因子。
  • do_normalize (bool，*可选*，默认为 self.do_normalize) — 是否对图像进行归一化。
  • do_convert_annotations (bool，*可选*，默认为 self.do_convert_annotations) — 是否将注释转换为模型期望的格式。将边界框的格式从 (top_left_x, top_left_y, width, height) 转换为 (center_x, center_y, width, height)，并使用相对坐标。
  • image_mean (float 或 List[float], *可选*, 默认值为 self.image_mean) — 图像归一化时使用的均值。
  • image_std (float 或 List[float], *可选*, 默认值为 self.image_std) — 图像归一化时使用的标准差。
  • do_pad (bool, *可选*, 默认值为 self.do_pad) — 是否对图像进行填充。如果为 True，则会在图像的底部和右侧使用零进行填充。如果提供了 pad_size，则图像将被填充到指定的维度。否则，图像将被填充到批次中的最大高度和宽度。
  • format (str 或 AnnotationFormat, *可选*, 默认值为 self.format) — 标注的格式。
  • return_tensors (str 或 TensorType, *可选*, 默认值为 self.return_tensors) — 要返回的张量类型。 如果为 None，则返回图像列表。
  • 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) 格式。
  • pad_size (Dict[str, int]，可选) — 用于将图像填充到的尺寸 {"height": int, "width" int}。必须大于为预处理提供的任何图像尺寸。如果未提供 pad_size，则图像将被填充到批次中的最大高度和宽度。

预处理一张或一批图像，以便模型可以使用它。

post_process_object_detection

< >

( outputs threshold: float = 0.5 target_sizes: Union = None ) → List[Dict]

参数

  • outputs (DetrObjectDetectionOutput) — 模型的原始输出。
  • threshold (float，可选) — 用于保留目标检测预测的得分阈值。
  • target_sizes (torch.Tensor 或 List[Tuple[int, int]]，可选) — 形状为 (batch_size, 2) 的张量或元组列表 (Tuple[int, int])，包含批次中每个图像的目标大小 (height, width)。如果未设置，则不会调整预测的大小。

返回

List[Dict]

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

将 DetrForObjectDetection 的原始输出转换为最终边界框，格式为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y)。仅支持 PyTorch。

post_process_semantic_segmentation

< >

( outputs target_sizes: List = None ) → List[torch.Tensor]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • target_sizes (List[Tuple[int, int]], 可选) — 一个元组列表 (Tuple[int, int])，包含批次中每个图像的目标大小（高度、宽度）。 如果未设置，预测将不会调整大小。

返回

List[torch.Tensor]

一个长度为 batch_size 的列表，其中每个项目都是一个形状为 (高度, 宽度) 的语义分割图，对应于 target_sizes 条目（如果指定了 target_sizes）。 每个 torch.Tensor 的每个条目对应于一个语义类 ID。

将 DetrForSegmentation 的输出转换为语义分割图。 仅支持 PyTorch。

post_process_instance_segmentation

< >

( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 target_sizes: Optional = None return_coco_annotation: Optional = False ) → List[Dict]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • threshold (float, 可选, 默认值为 0.5) — 用于保留预测实例掩码的概率分数阈值。
  • mask_threshold (float, 可选, 默认值为 0.5) — 将预测掩码转换为二进制值时使用的阈值。
  • overlap_mask_area_threshold (浮点，可选，默认为 0.8) — 用于合并或丢弃每个二进制实例掩码中小的不连续部分的重叠掩码区域阈值。
  • target_sizes (元组列表，可选) — 长度为 (batch_size) 的列表，其中每个列表项 (元组 [int，int]]) 对应于每个预测的请求最终大小（高度，宽度）。 如果未设置，则不会调整预测大小。
  • return_coco_annotation (布尔，可选) — 默认为 False。 如果设置为 True，则分割图以 COCO 游程长度编码 (RLE) 格式返回。

返回

List[Dict]

一个字典列表，每个图像对应一个字典，每个字典包含两个键

  • 分割 — 形状为 (高度，宽度) 的张量，其中每个像素表示一个 segment_id，如果 return_coco_annotation 设置为 True，则为分割图的 列表 [列表] 游程长度编码 (RLE)。 如果在 threshold 之上未找到掩码，则设置为 None。
  • segments_info — 包含每个段的附加信息的字典。
    • id — 表示 segment_id 的整数。
    • label_id — 表示与 segment_id 对应的标签/语义类 ID 的整数。
    • 分数 — 具有 segment_id 的段的预测分数。

将 DetrForSegmentation 的输出转换为实例分割预测。 仅支持 PyTorch。

post_process_panoptic_segmentation

< >

( 输出 阈值: 浮点 = 0.5 蒙版阈值: 浮点 = 0.5 overlap_mask_area_threshold: 浮点 = 0.8 label_ids_to_fuse: 可选 = 无 target_sizes: 可选 = 无 ) → 字典列表

参数

  • 输出 (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
  • 阈值 (浮点，可选，默认为 0.5) — 保留预测实例掩码的概率得分阈值。
  • mask_threshold (float，*可选*，默认为 0.5) — 将预测的掩码转换为二进制值时使用的阈值。
  • overlap_mask_area_threshold (float，*可选*，默认为 0.8) — 用于合并或丢弃每个二进制实例掩码中小的不连续部分的重叠掩码区域阈值。
  • label_ids_to_fuse (Set[int]，*可选*) — 此状态下的标签将将其所有实例融合在一起。例如，我们可以说一张图像中只能有一片天空，但可以有几个人，因此天空的标签 ID 将在该集合中，但人的标签 ID 不会在该集合中。
  • target_sizes (List[Tuple]，*可选*) — 长度为 (batch_size) 的列表，其中每个列表项 (Tuple[int, int]]) 对应于批处理中每个预测的请求最终大小（高度、宽度）。如果未设置，预测将不会调整大小。

返回

List[Dict]

一个字典列表，每个图像对应一个字典，每个字典包含两个键

  • segmentation — 形状为 (height, width) 的张量，其中每个像素表示一个 segment_id，如果在 threshold 以上没有找到掩码，则为 None。如果指定了 target_sizes，则分割将调整大小到相应的 target_sizes 条目。
  • segments_info — 包含每个段的附加信息的字典。
    • id — 表示 segment_id 的整数。
    • label_id — 表示与 segment_id 对应的标签/语义类 ID 的整数。
    • was_fused — 一个布尔值，如果 label_id 在 label_ids_to_fuse 中，则为 True，否则为 False。同一类/标签的多个实例被融合并分配了一个 segment_id。
    • 分数 — 具有 segment_id 的段的预测分数。

将 DetrForSegmentation 的输出转换为图像全景分割预测。仅支持 PyTorch。

DetrFeatureExtractor

类 transformers.DetrFeatureExtractor

< >

( *args **kwargs )

__call__

< >

( images **kwargs )

预处理一张或一批图像。

post_process_object_detection

< >

( outputs threshold: float = 0.5 target_sizes: Union = None ) → List[Dict]

参数

  • outputs (DetrObjectDetectionOutput) — 模型的原始输出。
  • threshold (float, 可选) — 用于保留对象检测预测的分数阈值。
  • target_sizes (torch.Tensor 或 List[Tuple[int, int]], 可选) — 形状为 (batch_size, 2) 的张量或元组列表 (Tuple[int, int])，包含批次中每个图像的目标大小 (height, width)。如果未设置，则不会调整预测的大小。

返回

List[Dict]

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

将 DetrForObjectDetection 的原始输出转换为最终边界框，格式为 (top_left_x, top_left_y, bottom_right_x, bottom_right_y)。仅支持 PyTorch。

post_process_semantic_segmentation

< >

( outputs target_sizes: List = None ) → List[torch.Tensor]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • target_sizes (List[Tuple[int, int]]，可选) — 包含批次中每个图像的目标大小（高度、宽度）的元组列表 (Tuple[int, int])。如果未设置，则不会调整预测大小。

返回

List[torch.Tensor]

一个长度为 batch_size 的列表，其中每个项目都是一个形状为 (高度, 宽度) 的语义分割图，对应于 target_sizes 条目（如果指定了 target_sizes）。 每个 torch.Tensor 的每个条目对应于一个语义类 ID。

将 DetrForSegmentation 的输出转换为语义分割图。 仅支持 PyTorch。

post_process_instance_segmentation

< >

( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 target_sizes: Optional = None return_coco_annotation: Optional = False ) → List[Dict]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • threshold (float，可选，默认为 0.5) — 用于保留预测的实例掩码的概率分数阈值。
  • mask_threshold (float，可选，默认为 0.5) — 将预测的掩码转换为二进制值时使用的阈值。
  • overlap_mask_area_threshold (float，可选，默认为 0.8) — 用于合并或丢弃每个二进制实例掩码中小的不连续部分的重叠掩码区域阈值。
  • target_sizes (List[Tuple]，可选) — 长度为 (batch_size) 的列表，其中每个列表项 (Tuple[int, int]]) 对应于每个预测请求的最终大小（高度、宽度）。如果未设置，则不会调整预测大小。
  • return_coco_annotation (bool，可选) — 默认值为 False。如果设置为 True，则分割掩码将以 COCO 游程编码 (RLE) 格式返回。

返回

List[Dict]

一个字典列表，每个图像对应一个字典，每个字典包含两个键

  • 分割 — 形状为 (高度，宽度) 的张量，其中每个像素表示一个 segment_id，如果 return_coco_annotation 设置为 True，则为分割图的 列表 [列表] 游程长度编码 (RLE)。 如果在 threshold 之上未找到掩码，则设置为 None。
  • segments_info — 包含每个段的附加信息的字典。
    • id — 表示 segment_id 的整数。
    • label_id — 表示与 segment_id 对应的标签/语义类 ID 的整数。
    • 分数 — 具有 segment_id 的段的预测分数。

将 DetrForSegmentation 的输出转换为实例分割预测。 仅支持 PyTorch。

post_process_panoptic_segmentation

< >

( 输出 阈值: 浮点 = 0.5 蒙版阈值: 浮点 = 0.5 overlap_mask_area_threshold: 浮点 = 0.8 label_ids_to_fuse: 可选 = 无 target_sizes: 可选 = 无 ) → 字典列表

参数

  • outputs (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
  • threshold (float，可选，默认为 0.5) — 用于保留预测实例掩码的概率分数阈值。
  • mask_threshold (float，可选，默认为 0.5) — 将预测掩码转换为二进制值时使用的阈值。
  • overlap_mask_area_threshold (float，可选，默认为 0.8) — 用于合并或丢弃每个二进制实例掩码中小的不连通部分的重叠掩码区域阈值。
  • label_ids_to_fuse (Set[int]，可选) — 此状态下的标签将使其所有实例融合在一起。例如，我们可以说一张图片中只能有一片天空，但可以有多个人，因此天空的标签 ID 将位于该集合中，而人的标签 ID 则不会。
  • target_sizes (List[Tuple]，可选) — 长度为 (batch_size) 的列表，其中每个列表项 (Tuple[int, int]]) 对应于批处理中每个预测请求的最终大小（高度、宽度）。如果未设置，则不会调整预测的大小。

返回

List[Dict]

一个字典列表，每个图像对应一个字典，每个字典包含两个键

  • segmentation — 形状为 (height, width) 的张量，其中每个像素表示一个 segment_id，如果在 threshold 以上没有找到掩码，则为 None。如果指定了 target_sizes，则分割将调整大小到相应的 target_sizes 条目。
  • segments_info — 包含每个段的附加信息的字典。
    • id — 表示 segment_id 的整数。
    • label_id — 表示与 segment_id 对应的标签/语义类 ID 的整数。
    • was_fused — 一个布尔值，如果 label_id 在 label_ids_to_fuse 中，则为 True，否则为 False。同一类/标签的多个实例被融合并分配了一个 segment_id。
    • 分数 — 具有 segment_id 的段的预测分数。

将 DetrForSegmentation 的输出转换为图像全景分割预测。仅支持 PyTorch。

DETR 特定输出

类 transformers.models.detr.modeling_detr.DetrModelOutput

 < >

( last_hidden_state: FloatTensor = None past_key_values: Optional = None decoder_hidden_states: Optional = None decoder_attentions: Optional = None cross_attentions: Optional = None encoder_last_hidden_state: Optional = None encoder_hidden_states: Optional = None encoder_attentions: Optional = None intermediate_hidden_states: Optional = None )

参数

  • last_hidden_state (torch.FloatTensor ， shape 为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor)，可选，传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 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 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。编码器在每一层输出处的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • intermediate_hidden_states (torch.FloatTensor, 形状为 (config.decoder_layers, batch_size, sequence_length, hidden_size), 可选, 当 config.auxiliary_loss=True 时返回) — 中间解码器激活，即每个解码器层的输出，每个输出都经过了层归一化。

DETR 编码器-解码器模型输出的基类。此类向 Seq2SeqModelOutput 添加了一个属性，即一个可选的中间解码器激活栈，即每个解码器层的输出，每个输出都经过了层归一化。这在使用辅助解码损失训练模型时非常有用。

类 transformers.models.detr.modeling_detr.DetrObjectDetectionOutput

< >

( loss: Optional = None loss_dict: Optional = None logits: FloatTensor = None pred_boxes: FloatTensor = None auxiliary_outputs: Optional = None last_hidden_state: Optional = None decoder_hidden_states: Optional = None decoder_attentions: Optional = None cross_attentions: Optional = None encoder_last_hidden_state: Optional = None encoder_hidden_states: Optional = None encoder_attentions: Optional = None )

参数

  • loss (torch.FloatTensor ， 形状为 (1,)，可选，在提供 labels 时返回) — 总损失，它是类别预测的负对数似然（交叉熵）和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
  • loss_dict (Dict，可选) — 包含各个损失的字典。对日志记录很有用。
  • logits (torch.FloatTensor ， 形状为 (batch_size, num_queries, num_classes + 1)) — 所有查询的分类 logits（包括非对象）。
  • pred_boxes (torch.FloatTensor ， 形状为 (batch_size, num_queries, 4)) — 所有查询的归一化边界框坐标，表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 中归一化，相对于批次中每个图像的大小（忽略可能的填充）。您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • auxiliary_outputs (list[Dict]，可选) — 可选，仅在激活辅助损失（即 config.auxiliary_loss 设置为 True）并提供标签时返回。它是一个字典列表，其中包含每个解码器层的两个上述键（logits 和 pred_boxes）。
  • last_hidden_state (torch.FloatTensor ， 形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选， 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。 解码器在每一层的输出处的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。 解码器交叉注意力层的注意力权重，在注意力 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 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。 编码器在每一层的输出处的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

DetrForObjectDetection 的输出类型。

class transformers.models.detr.modeling_detr.DetrSegmentationOutput

< >

( loss: Optional = None loss_dict: Optional = None logits: FloatTensor = None pred_boxes: FloatTensor = None pred_masks: FloatTensor = None auxiliary_outputs: Optional = None last_hidden_state: Optional = None decoder_hidden_states: Optional = None decoder_attentions: Optional = None cross_attentions: Optional = None encoder_last_hidden_state: Optional = None encoder_hidden_states: Optional = None encoder_attentions: Optional = None )

参数

  • loss (形状为 (1,) 的 torch.FloatTensor, 可选, 在提供 labels 时返回) — 总损失，作为类预测的负对数似然（交叉熵）和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
  • loss_dict (Dict, 可选) — 包含各个损失的字典。对日志记录很有用。
  • logits (形状为 (batch_size, num_queries, num_classes + 1) 的 torch.FloatTensor) — 所有查询的分类 logits（包括无对象）。
  • pred_boxes (torch.FloatTensor 形状为 (batch_size, num_queries, 4)) — 所有查询的归一化边界框坐标，表示为 (center_x, center_y, width, height)。 这些值在 [0, 1] 范围内进行归一化，相对于批次中每个图像的大小（忽略可能的填充）。 您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • pred_masks (torch.FloatTensor 形状为 (batch_size, num_queries, height/4, width/4)) — 所有查询的分割掩码 logits。另请参阅 post_process_semantic_segmentation() 或 post_process_instance_segmentation() post_process_panoptic_segmentation() 分别评估语义、实例和全景分割掩码。
  • auxiliary_outputs (list[Dict], 可选) — 可选，仅在激活辅助损失（即 config.auxiliary_loss 设置为 True）并提供标签时返回。 它是字典列表，其中包含每个解码器层的上述两个键（logits 和 pred_boxes）。
  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入输出 + 一个用于每层输出），形状为 (batch_size, sequence_length, hidden_size)。 解码器在每层输出处的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — torch.FloatTensor 的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 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 时返回) — torch.FloatTensor 的元组（嵌入的输出一个 + 每一层的输出一个），形状为 (batch_size, sequence_length, hidden_size)。编码器在每一层的输出处的隐藏状态加上初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

DetrForSegmentation 的输出类型。

DetrModel

类 transformers.DetrModel

< >

( config: DetrConfig )

参数

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

裸 DETR 模型（由骨干网络和编码器-解码器 Transformer 组成）输出原始隐藏状态，顶部没有任何特定头部。

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

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

前向传播

< >

( 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 output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.detr.modeling_detr.DetrModelOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略它。

    可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 DetrImageProcessor.call()。

  • 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)), 可选) — 元组包含 (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), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是使用零张量初始化查询。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.models.detr.modeling_detr.DetrModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置 (DetrConfig) 和输入的不同元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。解码器在每一层输出的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为 (batch_size, sequence_length, hidden_size)。编码器在每层输出处的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • intermediate_hidden_states (形状为 (config.decoder_layers, batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选, 当 config.auxiliary_loss=True 时返回) — 中间解码器激活，即每个解码器层的输出，每个输出都经过了层归一化。

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

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

例子

>>> from transformers import AutoImageProcessor, DetrModel
>>> 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("facebook/detr-resnet-50")
>>> model = DetrModel.from_pretrained("facebook/detr-resnet-50")

>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")

>>> # forward pass
>>> outputs = model(**inputs)

>>> # the last hidden states are the final query embeddings of the Transformer decoder
>>> # these are of shape (batch_size, num_queries, hidden_size)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 100, 256]

DetrForObjectDetection

类 transformers.DetrForObjectDetection

< >

( config: DetrConfig )

参数

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

DETR 模型（由一个骨干网络和一个编码器-解码器 Transformer 组成），顶部带有目标检测头，用于 COCO 检测等任务。

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

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

前向传播

< >

( 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.detr.modeling_detr.DetrObjectDetectionOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略它。

    像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 DetrImageProcessor.call()。

  • 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)，可选) — 元组包含 (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), 可选) — 可选参数，您可以选择直接传递嵌入表示，而不是使用零张量初始化查询。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (长度为 (batch_size,) 的 List[Dict], 可选) — 用于计算二分匹配损失的标签。字典列表，每个字典至少包含以下 2 个键：“class_labels”和“boxes”（分别为批次中图像的类别标签和边界框）。类别标签本身应为长度为 (图像中边界框的数量,) 的 torch.LongTensor，边界框应为形状为 (图像中边界框的数量, 4) 的 torch.FloatTensor。

返回

transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置 (DetrConfig) 和输入而定的各种元素。

  • loss (形状为 (1,) 的 torch.FloatTensor, 可选，当提供 labels 时返回) — 总损失，作为类别预测的负对数似然（交叉熵）和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
  • loss_dict (Dict, 可选) — 包含各个损失的字典。对日志记录很有用。
  • logits (形状为 (batch_size, num_queries, num_classes + 1) 的 torch.FloatTensor) — 所有查询的分类 logits（包括无对象）。
  • pred_boxes (形状为 (batch_size, num_queries, 4) 的 torch.FloatTensor) — 所有查询的归一化边界框坐标，表示为（中心点 x 坐标、中心点 y 坐标、宽度、高度）。这些值在 [0, 1] 范围内进行归一化，相对于批次中每个图像的大小（忽略可能的填充）。您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • auxiliary_outputs (list[Dict], 可选) — 可选参数，仅当激活辅助损失（即 config.auxiliary_loss 设置为 True）并提供标签时返回。它是一个字典列表，其中包含每个解码器层的上述两个键（logits 和 pred_boxes）。
  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。解码器在每一层输出的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为 (batch_size, sequence_length, hidden_size)。编码器在每层输出处的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

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

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

例子

>>> from transformers import AutoImageProcessor, DetrForObjectDetection
>>> import torch
>>> 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("facebook/detr-resnet-50")
>>> model = DetrForObjectDetection.from_pretrained("facebook/detr-resnet-50")

>>> 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.9, 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 remote with confidence 0.998 at location [40.16, 70.81, 175.55, 117.98]
Detected remote with confidence 0.996 at location [333.24, 72.55, 368.33, 187.66]
Detected couch with confidence 0.995 at location [-0.02, 1.15, 639.73, 473.76]
Detected cat with confidence 0.999 at location [13.24, 52.05, 314.02, 470.93]
Detected cat with confidence 0.999 at location [345.4, 23.85, 640.37, 368.72]

DetrForSegmentation

类 transformers.DetrForSegmentation

< >

( config: DetrConfig )

参数

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

DETR 模型（由一个主干网络和一个编码器-解码器 Transformer 组成），顶部有一个分割头，用于 COCO 全景分割等任务。

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

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

前向传播

< >

( pixel_values: FloatTensor pixel_mask: Optional[torch.FloatTensor] = None decoder_attention_mask: Optional[torch.FloatTensor] = None encoder_outputs: Optional[torch.FloatTensor] = None inputs_embeds: Optional[torch.FloatTensor] = None decoder_inputs_embeds: Optional[torch.FloatTensor] = None labels: Optional[torch.FloatTensor] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None ) → transformers.models.detr.modeling_detr.DetrSegmentationOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。如果您提供填充，默认情况下将忽略它。

    像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 DetrImageProcessor.call()。

  • 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)， 可选) — 元组包含 (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)， 可选) — 可选，您可以选择直接传递嵌入表示，而不是使用零张量初始化查询。
  • output_attentions (bool， 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool， 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput，而不是普通元组。
  • labels (List[Dict] 长度为 (batch_size,), 可选) — 用于计算二分匹配损失、DICE/F-1 损失和 Focal 损失的标签。字典列表，每个字典至少包含以下 3 个键："class_labels"、"boxes" 和 "masks"（分别对应批次中图像的类别标签、边界框和分割掩码）。类别标签本身应该是一个长度为 (图像中边界框的数量,) 的 torch.LongTensor，边界框是一个形状为 (图像中边界框的数量, 4) 的 torch.FloatTensor，掩码是一个形状为 (图像中边界框的数量, 高度, 宽度) 的 torch.FloatTensor。

返回

transformers.models.detr.modeling_detr.DetrSegmentationOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrSegmentationOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置（DetrConfig）和输入的不同元素。

  • loss (形状为 (1,) 的 torch.FloatTensor, 可选，当提供 labels 时返回) — 总损失，作为类别预测的负对数似然（交叉熵）和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
  • loss_dict (Dict, 可选) — 包含各个损失的字典。对日志记录很有用。
  • logits (形状为 (batch_size, num_queries, num_classes + 1) 的 torch.FloatTensor) — 所有查询的分类 logits（包括无对象）。
  • pred_boxes (形状为 (batch_size, num_queries, 4) 的 torch.FloatTensor) — 所有查询的归一化边界框坐标，表示为（中心点 x 坐标、中心点 y 坐标、宽度、高度）。这些值在 [0, 1] 范围内进行归一化，相对于批次中每个图像的大小（忽略可能的填充）。您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • pred_masks (torch.FloatTensor 形状为 (batch_size, num_queries, height/4, width/4)) — 所有查询的分割掩码 logits。另请参阅 post_process_semantic_segmentation() 或 post_process_instance_segmentation() post_process_panoptic_segmentation()，分别用于评估语义、实例和全景分割掩码。
  • auxiliary_outputs (list[Dict], 可选) — 可选，仅在激活辅助损失（即 config.auxiliary_loss 设置为 True）并提供标签时返回。它是一个字典列表，其中包含每个解码器层的上述两个键（logits 和 pred_boxes）。
  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。解码器在每一层输出的隐藏状态以及初始嵌入输出。
  • decoder_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.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
  • encoder_last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型编码器最后一层输出处的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为 (batch_size, sequence_length, hidden_size)。编码器在每层输出处的隐藏状态以及初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

DetrForSegmentation 的 forward 方法，覆盖了 __call__ 特殊方法。

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

例子

>>> import io
>>> import requests
>>> from PIL import Image
>>> import torch
>>> import numpy

>>> from transformers import AutoImageProcessor, DetrForSegmentation
>>> from transformers.image_transforms import rgb_to_id

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

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/detr-resnet-50-panoptic")
>>> model = DetrForSegmentation.from_pretrained("facebook/detr-resnet-50-panoptic")

>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")

>>> # forward pass
>>> outputs = model(**inputs)

>>> # Use the `post_process_panoptic_segmentation` method of the `image_processor` to retrieve post-processed panoptic segmentation maps
>>> # Segmentation results are returned as a list of dictionaries
>>> result = image_processor.post_process_panoptic_segmentation(outputs, target_sizes=[(300, 500)])

>>> # A tensor of shape (height, width) where each value denotes a segment id, filled with -1 if no segment is found
>>> panoptic_seg = result[0]["segmentation"]
>>> # Get prediction score and segment_id to class_id mapping of each segment
>>> panoptic_segments_info = result[0]["segments_info"]
< > 在 GitHub 上更新

←DETA DiNAT→