Transformers 文档

DETR

DETR

概述

DETR模型由Nicolas Carion、Francisco Massa、Gabriel Synnaeve、Nicolas Usunier、Alexander Kirillov和Sergey Zagoruyko在End-to-End Object Detection with Transformers中提出。DETR由一个卷积骨干网络和一个编码器-解码器Transformer组成,可以端到端地进行目标检测训练。它大大简化了像Faster-R-CNN和Mask-R-CNN这样的模型的复杂性,这些模型使用了区域提议、非极大值抑制过程和锚点生成等技术。此外,DETR还可以自然地扩展到全景分割,只需在解码器输出上添加一个掩码头即可。

论文的摘要如下:

我们提出了一种新方法,将目标检测视为一个直接的集合预测问题。我们的方法简化了检测流程,有效地消除了对许多手工设计组件的需求,如非极大值抑制过程或锚点生成,这些组件明确编码了我们对任务的先验知识。新框架的主要组成部分,称为DEtection TRansformer或DETR,是一个基于集合的全局损失,通过二分匹配强制唯一预测,以及一个变压器编码器-解码器架构。给定一组固定的学习对象查询,DETR推理对象之间的关系和全局图像上下文,以并行方式直接输出最终的预测集合。新模型在概念上简单,不需要专门的库,与许多其他现代检测器不同。DETR在具有挑战性的COCO目标检测数据集上展示了与成熟且高度优化的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 可以自然地扩展到执行全景分割(统一了语义分割和实例分割)。DetrForSegmentationDetrForObjectDetection 的基础上添加了一个分割掩码头。掩码头可以联合训练,也可以分两步进行,首先训练一个 DetrForObjectDetection 模型来检测“事物”(实例)和“背景”(如树木、道路、天空等)的边界框,然后冻结所有权重,仅训练掩码头 25 个周期。实验表明,这两种方法的结果相似。需要注意的是,预测边界框是训练的必要条件,因为匈牙利匹配是基于边界框之间的距离计算的。

使用提示

  • DETR 使用所谓的对象查询来检测图像中的对象。查询的数量决定了单张图像中可以检测到的最大对象数量,默认设置为100(参见DetrConfig的参数num_queries)。请注意,留有一些余地是好的(在COCO中,作者使用了100,而COCO图像中的最大对象数量约为70)。
  • DETR的解码器并行更新查询嵌入。这与GPT-2等语言模型不同,后者使用自回归解码而不是并行解码。因此,不使用因果注意力掩码。
  • DETR在每个自注意力和交叉注意力层之前将位置嵌入添加到隐藏状态,然后投影到查询和键。对于图像的位置嵌入,可以选择固定的正弦或学习的绝对位置嵌入。默认情况下,DetrConfig的参数position_embedding_type设置为"sine"
  • 在训练过程中,DETR的作者确实发现使用解码器中的辅助损失是有帮助的,特别是帮助模型输出每个类别的正确数量的对象。如果您将DetrConfig的参数auxiliary_loss设置为True,则在每个解码器层之后添加预测前馈神经网络和匈牙利损失(FFNs共享参数)。
  • 如果你想在多个节点的分布式环境中训练模型,那么应该更新modeling_detr.py文件中DetrLoss类的num_boxes变量。在多个节点上训练时,这应该设置为所有节点上目标框的平均数量,如原始实现中所示这里
  • DetrForObjectDetectionDetrForSegmentation 可以使用 timm library 中的任何卷积骨干网络进行初始化。 例如,可以通过将 DetrConfigbackbone 属性设置为 "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:使用随机初始化的权重实例化DETR的Transformer,但使用预训练的权重作为骨干网络

>>> from transformers import DetrConfig, DetrForObjectDetection

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

选项3:使用随机初始化的权重实例化DETR,用于骨干网络和Transformer

>>> 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的后处理方法之一转换模型的输出。这些可以提供给CocoEvaluatorPanopticEvaluator,它们允许你计算诸如平均精度(mAP)和全景质量(PQ)等指标。后者的对象在原始仓库中实现。有关评估的更多信息,请参阅示例笔记本

资源

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

Object Detection

如果您有兴趣提交资源以包含在此处,请随时打开一个 Pull Request,我们将进行审核!理想情况下,资源应展示一些新内容,而不是重复现有资源。

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 (PretrainedConfigdict, 可选) — 骨干模型的配置。仅在 use_timm_backbone 设置为 False 时使用,此时它将默认为 ResNetConfig().
  • num_channels (int, optional, 默认为 3) — 输入通道的数量。
  • num_queries (int, 可选, 默认为 100) — 对象查询的数量,即检测槽。这是 DetrModel 在单张图片中可以检测到的最大对象数量。对于 COCO,我们推荐使用 100 个查询。
  • d_model (int, optional, 默认为 256) — 层的维度.
  • encoder_layers (int, optional, 默认为 6) — 编码器层数.
  • decoder_layers (int, optional, defaults to 6) — 解码器层数.
  • encoder_attention_heads (int, optional, 默认为 8) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_attention_heads (int, optional, defaults to 8) — Transformer解码器中每个注意力层的注意力头数量。
  • decoder_ffn_dim (int, optional, defaults to 2048) — 解码器中“中间”(通常称为前馈)层的维度。
  • encoder_ffn_dim (int, optional, defaults to 2048) — 解码器中“中间”(通常称为前馈)层的维度。
  • activation_function (strfunction, 可选, 默认为 "relu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""silu""gelu_new"
  • dropout (float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的dropout概率。
  • attention_dropout (float, optional, defaults to 0.0) — 注意力概率的dropout比率.
  • activation_dropout (float, optional, 默认为 0.0) — 全连接层内激活函数的丢弃比例。
  • init_std (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • init_xavier_std (float, optional, 默认为 1) — 用于 HM 注意力图模块中 Xavier 初始化增益的缩放因子。
  • encoder_layerdrop (float, 可选, 默认为 0.0) — 编码器的LayerDrop概率。有关更多详细信息,请参阅[LayerDrop论文](see https://arxiv.org/abs/1909.11556)。
  • decoder_layerdrop (float, 可选, 默认为 0.0) — 解码器的LayerDrop概率。更多详情请参阅[LayerDrop论文](see https://arxiv.org/abs/1909.11556)
  • auxiliary_loss (bool, 可选, 默认为 False) — 是否使用辅助解码损失(每个解码器层的损失)。
  • position_embedding_type (str, optional, defaults to "sine") — 用于图像特征之上的位置嵌入类型。可选值为 "sine""learned".
  • backbone (str, 可选, 默认为 "resnet50") — 当 backbone_configNone 时使用的骨干网络名称。如果 use_pretrained_backboneTrue,这将从 timm 或 transformers 库加载相应的预训练权重。如果 use_pretrained_backboneFalse,这将加载骨干网络的配置并使用该配置初始化具有随机权重的骨干网络。
  • use_pretrained_backbone (bool, optional, True) — 是否使用预训练的权重作为骨干网络。
  • backbone_kwargs (dict, optional) — 从检查点加载时传递给AutoBackbone的关键字参数 例如 {'out_indices': (0, 1, 2, 3)}。如果设置了backbone_config,则不能指定此参数。
  • dilation (bool, 可选, 默认为 False) — 是否在最后一个卷积块(DC5)中用扩张替换步幅。仅在 use_timm_backbone = True 时支持。
  • class_cost (float, optional, 默认为 1) — 匈牙利匹配成本中分类错误的相对权重。
  • bbox_cost (float, 可选, 默认为 5) — 匈牙利匹配成本中边界框坐标的L1误差的相对权重。
  • giou_cost (float, optional, 默认为 2) — 在匈牙利匹配成本中,边界框的广义 IoU 损失的相对权重。
  • mask_loss_coefficient (float, optional, defaults to 1) — 全景分割损失中Focal损失的相对权重。
  • dice_loss_coefficient (float, optional, defaults to 1) — 在全景分割损失中,DICE/F-1损失的相对权重。
  • bbox_loss_coefficient (float, optional, defaults to 5) — 目标检测损失中L1边界框损失的相对权重。
  • giou_loss_coefficient (float, optional, defaults to 2) — 在目标检测损失中,广义IoU损失的相对权重。
  • eos_coefficient (float, optional, 默认为 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

参数

返回

DetrConfig

配置对象的一个实例

从预训练的主干模型配置实例化一个DetrConfig(或派生类)。

DetrImageProcessor

transformers.DetrImageProcessor

< >

( format: typing.Union[str, transformers.image_utils.AnnotationFormat] = do_resize: bool = True size: typing.Dict[str, int] = None resample: Resampling = do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.List[float]] = None image_std: typing.Union[float, typing.List[float]] = None do_convert_annotations: typing.Optional[bool] = None do_pad: bool = True pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )

参数

  • format (str, optional, defaults to "coco_detection") — 注释的数据格式。可选值为“coco_detection”或“coco_panoptic”。
  • do_resize (bool, 可选, 默认为 True) — 控制是否将图像的(height, width)尺寸调整为指定的size。可以在preprocess方法中通过do_resize参数进行覆盖。
  • size (Dict[str, int] optional, defaults to {"shortest_edge" -- 800, "longest_edge": 1333}): Size of the image’s (height, width) dimensions after resizing. Can be overridden by the size parameter in the preprocess method. Available options are:
    • {"height": int, "width": int}: The image will be resized to the exact size (height, width). Do NOT keep the aspect ratio.
    • {"shortest_edge": int, "longest_edge": int}: The image will be resized to a maximum size respecting the aspect ratio and keeping the shortest edge less or equal to shortest_edge and the longest edge less or equal to longest_edge.
    • {"max_height": int, "max_width": int}: The image will be resized to the maximum size respecting the aspect ratio and keeping the height less or equal to max_height and the width less or equal to max_width.
  • resample (PILImageResampling, 可选, 默认为 PILImageResampling.BILINEAR) — 如果调整图像大小,使用的重采样过滤器。
  • do_rescale (bool, 可选, 默认为 True) — 控制是否通过指定的比例 rescale_factor 重新缩放图像。可以在 preprocess 方法中通过 do_rescale 参数覆盖此设置。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 如果重新缩放图像,则使用的缩放因子。可以在 preprocess 方法中通过 rescale_factor 参数覆盖此值。
  • do_normalize (bool, 可选, 默认为 True) — 控制是否对图像进行归一化。可以在 preprocess 方法中通过 do_normalize 参数进行覆盖。
  • 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,图像将被填充到批次中最大的高度和宽度。

构建一个Detr图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), typing.List[ForwardRef('PIL.Image.Image')], typing.List[numpy.ndarray], typing.List[ForwardRef('torch.Tensor')]] annotations: typing.Union[typing.Dict[str, typing.Union[int, str, typing.List[typing.Dict]]], typing.List[typing.Dict[str, typing.Union[int, str, typing.List[typing.Dict]]]], NoneType] = None return_segmentation_masks: bool = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[typing.Dict[str, int]] = None resample = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Union[int, float, NoneType] = None do_normalize: typing.Optional[bool] = None do_convert_annotations: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None do_pad: typing.Optional[bool] = None format: typing.Union[str, transformers.image_utils.AnnotationFormat, NoneType] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Union[str, transformers.image_utils.ChannelDimension] = input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )

参数

  • 图像 (ImageInput) — 要预处理的图像或图像批次。期望输入单个或批次的图像,像素值范围为0到255。如果传入的图像的像素值在0到1之间,请设置do_rescale=False.
  • annotations (AnnotationType or List[AnnotationType], optional) — List of annotations associated with the image or batch of images. If annotation is for object detection, the annotations should be a dictionary with the following keys:
    • “image_id” (int): The image id.
    • “annotations” (List[Dict]): List of annotations for an image. Each annotation should be a dictionary. An image can have no annotations, in which case the list should be empty. If annotation is for segmentation, the annotations should be a dictionary with the following keys:
    • “image_id” (int): The image id.
    • “segments_info” (List[Dict]): List of segments for an image. Each segment should be a dictionary. An image can have no segments, in which case the list should be empty.
    • “file_name” (str): The file name of the image.
  • return_segmentation_masks (bool, optional, defaults to self.return_segmentation_masks) — 是否返回分割掩码。
  • masks_path (str or pathlib.Path, optional) — 包含分割掩码的目录路径。
  • do_resize (bool, optional, defaults to self.do_resize) — 是否调整图像大小.
  • size (Dict[str, int], optional, defaults to self.size) — Size of the image’s (height, width) dimensions after resizing. Available options are:
    • {"height": int, "width": int}: The image will be resized to the exact size (height, width). Do NOT keep the aspect ratio.
    • {"shortest_edge": int, "longest_edge": int}: The image will be resized to a maximum size respecting the aspect ratio and keeping the shortest edge less or equal to shortest_edge and the longest edge less or equal to longest_edge.
    • {"max_height": int, "max_width": int}: The image will be resized to the maximum size respecting the aspect ratio and keeping the height less or equal to max_height and the width less or equal to max_width.
  • resample (PILImageResampling, optional, defaults to self.resample) — 调整图像大小时使用的重采样过滤器。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否对图像进行重新缩放.
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 在重新缩放图像时使用的重新缩放因子。
  • do_normalize (bool, optional, defaults to 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 (floatList[float], 可选, 默认为 self.image_mean) — 在标准化图像时使用的均值。
  • image_std (float or List[float], optional, defaults to self.image_std) — 用于图像归一化的标准差。
  • 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: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) List[Dict]

参数

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

返回

List[Dict]

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

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

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) List[torch.Tensor]

参数

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

返回

List[torch.Tensor]

一个长度为 batch_size 的列表,其中每个项目都是一个形状为 (height, width) 的语义分割图,对应于 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: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) List[Dict]

参数

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

返回

List[Dict]

一个字典列表,每个图像一个,每个字典包含两个键:

  • segmentation — 一个形状为 (height, width) 的张量,其中每个像素代表一个 segment_idList[List] 运行长度编码(RLE)的分割图,如果 return_coco_annotation 设置为 True。如果没有找到高于 threshold 的掩码,则设置为 None
  • segments_info — 一个包含每个片段附加信息的字典。
    • id — 一个表示 segment_id 的整数。
    • label_id — 一个表示与 segment_id 对应的标签/语义类 ID 的整数。
    • score — 具有 segment_id 的片段的预测分数。

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

post_process_panoptic_segmentation

< >

( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) List[Dict]

参数

  • 输出 (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
  • threshold (float, optional, defaults to 0.5) — 用于保留预测实例掩码的概率分数阈值。
  • mask_threshold (float, optional, defaults to 0.5) — 用于将预测的掩码转换为二进制值的阈值。
  • overlap_mask_area_threshold (float, optional, 默认为 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_idlabel_ids_to_fuse 中,则为 True,否则为 False。相同类/标签的多个实例被融合并分配一个 segment_id
    • score — 具有 segment_id 的段的预测分数。

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

DetrImageProcessorFast

transformers.DetrImageProcessorFast

< >

( format: typing.Union[str, transformers.image_utils.AnnotationFormat] = do_resize: bool = True size: typing.Dict[str, int] = None resample: typing.Union[PIL.Image.Resampling, ForwardRef('F.InterpolationMode')] = do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.List[float]] = None image_std: typing.Union[float, typing.List[float]] = None do_convert_annotations: typing.Optional[bool] = None do_pad: bool = True pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )

参数

  • format (str, 可选, 默认为 AnnotationFormat.COCO_DETECTION) — 注释的数据格式。可以是“coco_detection”或“coco_panoptic”之一。
  • do_resize (bool, 可选, 默认为 True) — 控制是否将图像的(height, width)尺寸调整为指定的size。可以在preprocess方法中通过do_resize参数进行覆盖。
  • size (Dict[str, int] optional, defaults to {"shortest_edge" -- 800, "longest_edge": 1333}): Size of the image’s (height, width) dimensions after resizing. Can be overridden by the size parameter in the preprocess method. Available options are:
    • {"height": int, "width": int}: The image will be resized to the exact size (height, width). Do NOT keep the aspect ratio.
    • {"shortest_edge": int, "longest_edge": int}: The image will be resized to a maximum size respecting the aspect ratio and keeping the shortest edge less or equal to shortest_edge and the longest edge less or equal to longest_edge.
    • {"max_height": int, "max_width": int}: The image will be resized to the maximum size respecting the aspect ratio and keeping the height less or equal to max_height and the width less or equal to max_width.
  • resample (PILImageResampling, optional, defaults to PILImageResampling.BILINEAR) — 如果调整图像大小,则使用的重采样过滤器。
  • do_rescale (bool, 可选, 默认为 True) — 控制是否通过指定的比例 rescale_factor 重新缩放图像。可以在 preprocess 方法中通过 do_rescale 参数覆盖此设置。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 如果重新缩放图像,则使用的缩放因子。可以在 preprocess 方法中通过 rescale_factor 参数覆盖此值。
  • do_normalize (bool, 可选, 默认为 True) — 控制是否对图像进行归一化。可以在 preprocess 方法中通过 do_normalize 参数进行覆盖。
  • 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], optional) — 图像填充的大小 {"height": int, "width" int}。必须大于任何预处理提供的图像大小。 如果未提供 pad_size,图像将被填充到批次中最大的高度和宽度。

构建一个快速的Detr图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), typing.List[ForwardRef('PIL.Image.Image')], typing.List[numpy.ndarray], typing.List[ForwardRef('torch.Tensor')]] annotations: typing.Union[typing.Dict[str, typing.Union[int, str, typing.List[typing.Dict]]], typing.List[typing.Dict[str, typing.Union[int, str, typing.List[typing.Dict]]]], NoneType] = None return_segmentation_masks: bool = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[typing.Dict[str, int]] = None resample: typing.Union[PIL.Image.Resampling, ForwardRef('F.InterpolationMode'), NoneType] = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Union[int, float, NoneType] = None do_normalize: typing.Optional[bool] = None do_convert_annotations: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None do_pad: typing.Optional[bool] = None format: typing.Union[str, transformers.image_utils.AnnotationFormat, NoneType] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Union[str, transformers.image_utils.ChannelDimension] = input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None pad_size: typing.Optional[typing.Dict[str, int]] = None **kwargs )

参数

  • 图像 (ImageInput) — 要预处理的图像或图像批次。期望输入单个或批次的图像,像素值范围为0到255。如果传入的图像的像素值在0到1之间,请设置do_rescale=False.
  • annotations (AnnotationType or List[AnnotationType], optional) — List of annotations associated with the image or batch of images. If annotation is for object detection, the annotations should be a dictionary with the following keys:
    • “image_id” (int): The image id.
    • “annotations” (List[Dict]): List of annotations for an image. Each annotation should be a dictionary. An image can have no annotations, in which case the list should be empty. If annotation is for segmentation, the annotations should be a dictionary with the following keys:
    • “image_id” (int): The image id.
    • “segments_info” (List[Dict]): List of segments for an image. Each segment should be a dictionary. An image can have no segments, in which case the list should be empty.
    • “file_name” (str): The file name of the image.
  • return_segmentation_masks (bool, optional, defaults to self.return_segmentation_masks) — 是否返回分割掩码。
  • masks_path (str or pathlib.Path, optional) — 包含分割掩码的目录路径。
  • do_resize (bool, optional, defaults to self.do_resize) — 是否调整图像大小.
  • size (Dict[str, int], optional, defaults to self.size) — Size of the image’s (height, width) dimensions after resizing. Available options are:
    • {"height": int, "width": int}: The image will be resized to the exact size (height, width). Do NOT keep the aspect ratio.
    • {"shortest_edge": int, "longest_edge": int}: The image will be resized to a maximum size respecting the aspect ratio and keeping the shortest edge less or equal to shortest_edge and the longest edge less or equal to longest_edge.
    • {"max_height": int, "max_width": int}: The image will be resized to the maximum size respecting the aspect ratio and keeping the height less or equal to max_height and the width less or equal to max_width.
  • resample (PILImageResamplingInterpolationMode, 可选, 默认为 self.resample) — 调整图像大小时使用的重采样过滤器。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否对图像进行重新缩放.
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 在重新缩放图像时使用的重新缩放因子。
  • do_normalize (bool, optional, defaults to 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 (floatList[float], 可选, 默认为 self.image_mean) — 在标准化图像时使用的均值。
  • image_std (float or List[float], optional, defaults to self.image_std) — 用于图像归一化的标准差。
  • 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: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) List[Dict]

参数

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

返回

List[Dict]

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

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

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) List[torch.Tensor]

参数

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

返回

List[torch.Tensor]

一个长度为 batch_size 的列表,其中每个项目都是一个形状为 (height, width) 的语义分割图,对应于 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: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) List[Dict]

参数

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

返回

List[Dict]

一个字典列表,每个图像一个,每个字典包含两个键:

  • segmentation — 一个形状为 (height, width) 的张量,其中每个像素代表一个 segment_idList[List] 运行长度编码(RLE)的分割图,如果 return_coco_annotation 设置为 True。如果没有找到高于 threshold 的掩码,则设置为 None
  • segments_info — 一个包含每个片段附加信息的字典。
    • id — 一个表示 segment_id 的整数。
    • label_id — 一个表示与 segment_id 对应的标签/语义类 ID 的整数。
    • score — 具有 segment_id 的片段的预测分数。

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

post_process_panoptic_segmentation

< >

( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) List[Dict]

参数

  • 输出 (DetrForSegmentation) — 来自 DetrForSegmentation 的输出.
  • threshold (float, optional, defaults to 0.5) — 用于保留预测实例掩码的概率分数阈值。
  • mask_threshold (float, optional, defaults to 0.5) — 用于将预测的掩码转换为二进制值的阈值。
  • overlap_mask_area_threshold (float, optional, defaults to 0.8) — 用于合并或丢弃每个二进制实例掩码中小的不连接部分的重叠掩码区域阈值。
  • label_ids_to_fuse (Set[int], 可选) — 此状态中的标签将使其所有实例融合在一起。例如,我们可以说 一张图片中只能有一个天空,但可以有几个人,所以天空的标签ID会在该集合中, 但人的标签ID不会在其中。
  • target_sizes (List[Tuple], optional) — 长度为 (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_idlabel_ids_to_fuse 中,则为 True,否则为 False。相同类/标签的多个实例被融合并分配一个 segment_id
    • score — 具有 segment_id 的段的预测分数。

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

DetrFeatureExtractor

transformers.DetrFeatureExtractor

< >

( *args **kwargs )

__call__

< >

( images **kwargs )

预处理一张图像或一批图像。

post_process_object_detection

< >

( outputs threshold: float = 0.5 target_sizes: typing.Union[transformers.utils.generic.TensorType, typing.List[typing.Tuple]] = None ) List[Dict]

参数

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

返回

List[Dict]

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

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

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.List[typing.Tuple[int, int]] = None ) List[torch.Tensor]

参数

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

返回

List[torch.Tensor]

一个长度为 batch_size 的列表,其中每个项目都是一个形状为 (height, width) 的语义分割图,对应于 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: typing.Optional[typing.List[typing.Tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = False ) List[Dict]

参数

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

返回

List[Dict]

一个字典列表,每个图像一个,每个字典包含两个键:

  • segmentation — 一个形状为 (height, width) 的张量,其中每个像素代表一个 segment_idList[List] 运行长度编码(RLE)的分割图,如果 return_coco_annotation 设置为 True。如果没有找到高于 threshold 的掩码,则设置为 None
  • segments_info — 一个包含每个片段附加信息的字典。
    • id — 一个表示 segment_id 的整数。
    • label_id — 一个表示与 segment_id 对应的标签/语义类 ID 的整数。
    • score — 具有 segment_id 的片段的预测分数。

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

post_process_panoptic_segmentation

< >

( outputs threshold: float = 0.5 mask_threshold: float = 0.5 overlap_mask_area_threshold: float = 0.8 label_ids_to_fuse: typing.Optional[typing.Set[int]] = None target_sizes: typing.Optional[typing.List[typing.Tuple[int, int]]] = None ) List[Dict]

参数

  • 输出 (DetrForSegmentation) — 来自 DetrForSegmentation 的输出。
  • threshold (float, optional, defaults to 0.5) — 用于保留预测实例掩码的概率分数阈值。
  • mask_threshold (float, optional, defaults to 0.5) — 用于将预测的掩码转换为二进制值的阈值。
  • overlap_mask_area_threshold (float, optional, defaults to 0.8) — 用于合并或丢弃每个二进制实例掩码内小断开部分的重叠掩码区域阈值。
  • label_ids_to_fuse (Set[int], 可选) — 此状态中的标签将把它们的所有实例融合在一起。例如,我们可以说 一张图片中只能有一个天空,但可以有几个人,所以天空的标签ID会在那个 集合中,但人的标签ID不会在其中。
  • target_sizes (List[Tuple], optional) — 长度为 (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_idlabel_ids_to_fuse 中,则为 True,否则为 False。相同类/标签的多个实例被融合并分配一个 segment_id
    • score — 具有 segment_id 的段的预测分数。

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

DETR 特定输出

transformers.models.detr.modeling_detr.DetrModelOutput

< >

( last_hidden_state: FloatTensor = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None intermediate_hidden_states: typing.Optional[torch.FloatTensor] = None )

参数

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

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

transformers.models.detr.modeling_detr.DetrObjectDetectionOutput

< >

( loss: typing.Optional[torch.FloatTensor] = None loss_dict: typing.Optional[typing.Dict] = None logits: FloatTensor = None pred_boxes: FloatTensor = None auxiliary_outputs: typing.Optional[typing.List[typing.Dict]] = None last_hidden_state: typing.Optional[torch.FloatTensor] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )

参数

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 总损失是类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为 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)) — 所有查询的归一化框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • auxiliary_outputs (list[Dict], 可选) — 可选,仅在辅助损失被激活时返回(即 config.auxiliary_loss 设置为 True) 并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logitspred_boxes)。
  • last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型解码器最后一层输出的隐藏状态序列。
  • 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=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器的交叉注意力层的注意力权重,在注意力 softmax 之后, 用于计算交叉注意力头中的加权平均值。
  • encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层输出的隐藏状态序列。
  • 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=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

DetrForObjectDetection的输出类型。

class transformers.models.detr.modeling_detr.DetrSegmentationOutput

< >

( loss: typing.Optional[torch.FloatTensor] = None loss_dict: typing.Optional[typing.Dict] = None logits: FloatTensor = None pred_boxes: FloatTensor = None pred_masks: FloatTensor = None auxiliary_outputs: typing.Optional[typing.List[typing.Dict]] = None last_hidden_state: typing.Optional[torch.FloatTensor] = None decoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None decoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None cross_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_last_hidden_state: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None encoder_attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )

参数

  • loss (torch.FloatTensor of shape (1,), optional, 当提供labels时返回) — 总损失是类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为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)) — 所有查询的归一化框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索未归一化的边界框。
  • pred_masks (torch.FloatTensor of shape (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) 并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logitspred_boxes)。
  • last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出)的形状为 (batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态加上初始嵌入输出。
  • decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器的交叉注意力层的注意力权重,在注意力 softmax 之后, 用于计算交叉注意力头中的加权平均值。
  • encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层输出的隐藏状态序列。
  • 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=Trueconfig.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: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.detr.modeling_detr.DetrModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — Pixel values. Padding will be ignored by default should you provide it.

    可以使用AutoImageProcessor获取像素值。详情请参见DetrImageProcessor.call()

  • pixel_mask (torch.LongTensor of shape (batch_size, height, width), optional) — Mask to avoid performing attention on padding pixel values. Mask values selected in [0, 1]:
    • 1 for pixels that are real (i.e. not masked),
    • 0 for pixels that are padding (i.e. masked).

    什么是注意力掩码?

  • decoder_attention_mask (torch.FloatTensor of shape (batch_size, num_queries), optional) — 默认不使用。可用于屏蔽对象查询。
  • 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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。
  • decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, num_queries, hidden_size), optional) — 可选地,您可以选择直接传递一个嵌入表示,而不是用零张量初始化查询。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.models.detr.modeling_detr.DetrModelOutputtuple(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 (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 时返回) — 中间解码器激活,即每层解码器的输出,每层都经过了一个 层归一化。

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: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[typing.List[dict]] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.detr.modeling_detr.DetrObjectDetectionOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — Pixel values. Padding will be ignored by default should you provide it.

    可以使用AutoImageProcessor获取像素值。详情请参见DetrImageProcessor.call()

  • pixel_mask (torch.LongTensor of shape (batch_size, height, width), optional) — Mask to avoid performing attention on padding pixel values. Mask values selected in [0, 1]:
    • 1 for pixels that are real (i.e. not masked),
    • 0 for pixels that are padding (i.e. masked).

    什么是注意力掩码?

  • decoder_attention_mask (torch.FloatTensor of shape (batch_size, num_queries), optional) — 默认不使用。可用于屏蔽对象查询。
  • 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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。
  • decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, num_queries, hidden_size), optional) — 可选地,您可以选择直接传递一个嵌入表示,而不是用零张量初始化查询。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • labels (List[Dict] 长度为 (batch_size,), 可选) — 用于计算二分匹配损失的标签。字典列表,每个字典至少包含以下两个键:'class_labels' 和 'boxes'(分别是批次中图像的类别标签和边界框)。类别标签本身应为长度为 (图像中边界框的数量,)torch.LongTensor,而边界框应为形状为 (图像中边界框的数量, 4)torch.FloatTensor

返回

transformers.models.detr.modeling_detr.DetrObjectDetectionOutputtuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(DetrConfig)和输入。

  • 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) 并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logitspred_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 的前向方法,重写了 __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: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.FloatTensor] = None encoder_outputs: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[typing.List[dict]] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.detr.modeling_detr.DetrSegmentationOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — Pixel values. Padding will be ignored by default should you provide it.

    可以使用AutoImageProcessor获取像素值。详情请参见DetrImageProcessor.call()

  • pixel_mask (torch.LongTensor of shape (batch_size, height, width), optional) — Mask to avoid performing attention on padding pixel values. Mask values selected in [0, 1]:
    • 1 for pixels that are real (i.e. not masked),
    • 0 for pixels that are padding (i.e. masked).

    什么是注意力掩码?

  • decoder_attention_mask (torch.FloatTensor of shape (batch_size, num_queries), optional) — 默认不使用。可用于屏蔽对象查询。
  • 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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递图像的扁平化表示,而不是传递扁平化的特征图(骨干网络 + 投影层的输出)。
  • decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, num_queries, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是用零张量初始化查询。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回的张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • labels (List[Dict] 长度为 (batch_size,), 可选) — 用于计算二分匹配损失、DICE/F-1损失和焦点损失的标签。字典列表,每个字典至少包含以下3个键:'class_labels'、'boxes'和'masks'(分别是批次中图像的类别标签、边界框和分割掩码)。类别标签本身应为长度为 (图像中边界框的数量,)torch.LongTensor,边界框为形状为 (图像中边界框的数量, 4)torch.FloatTensor,掩码为形状为 (图像中边界框的数量, 高度, 宽度)torch.FloatTensor.

返回

transformers.models.detr.modeling_detr.DetrSegmentationOutputtuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrSegmentationOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(DetrConfig)和输入。

  • 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() 来检索 未归一化的边界框。
  • 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) 并且提供了标签。它是一个字典列表,包含每个解码器层的上述两个键(logitspred_boxes)。
  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 模型解码器最后一层输出的隐藏状态序列。
  • decoder_hidden_states (tuple(torch.FloatTensor)可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组(一个用于嵌入输出 + 一个用于每层输出),形状为 (batch_size, sequence_length, hidden_size)。解码器在每层输出处的隐藏状态加上初始嵌入输出。
  • decoder_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重,在注意力 softmax 之后,用于计算 自注意力头中的加权平均值。
  • cross_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=Trueconfig.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=Trueconfig.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组(一个用于嵌入输出 + 一个用于每层输出),形状为 (batch_size, sequence_length, hidden_size)。编码器在每层输出处的隐藏状态加上初始嵌入输出。
  • encoder_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重,在注意力 softmax 之后,用于计算 自注意力头中的加权平均值。

DetrForSegmentation 的前向方法,重写了 __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"]
< > Update on GitHub