Transformers 文档

DETR

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

DETR

PyTorch

概述

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 还可以通过简单地在解码器输出之上添加一个掩码头来自然地扩展到执行全景分割。

论文摘要如下:

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

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

DETR 工作原理

以下是关于 DetrForObjectDetection 工作原理的 TLDR 解释

首先,图像通过预训练的卷积骨干网络(在论文中,作者使用 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 个 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* 变量。在多节点训练时,这应设置为所有节点上目标框的平均数量,如原始实现 此处 所示。
  • DetrForObjectDetectionDetrForSegmentation 可以使用 timm 库中可用的任何卷积骨干网络进行初始化。例如,通过将 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)

总结一下,请看下表

任务 目标检测 实例分割 全景分割
描述 预测图像中对象的边界框和类别标签 预测图像中对象(即实例)的掩码 预测图像中对象(即实例)以及“stuff”(即背景事物,如树木和道路)的掩码
模型 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 with iou_types="bbox" CocoEvaluator with iou_types="bbox" or "segm" CocoEvaluator with iou_tupes="bbox" or "segm", PanopticEvaluator

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

资源

Hugging Face 官方和社区(以 🌎 标示)资源列表,助您快速开始使用 DETR。

物体检测

如果您有兴趣在此处提交资源,请随时开启 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, 可选, 默认为 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 (strfunction, 可选, 默认为 "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 Attention 模块中 Xavier 初始化增益的缩放因子。
  • encoder_layerdrop (float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。
  • decoder_layerdrop (float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/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 loss 的相对权重。
  • 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

参数

返回

DetrConfig

一个配置对象的实例

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

DetrImageProcessor

class transformers.DetrImageProcessor

< >

( format: typing.Union[str, transformers.image_utils.AnnotationFormat] = <AnnotationFormat.COCO_DETECTION: 'coco_detection'> do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_convert_annotations: typing.Optional[bool] = None do_pad: bool = True pad_size: typing.Optional[dict[str, int]] = 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 (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 图像处理器。

preprocess

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] annotations: typing.Union[dict[str, typing.Union[int, str, list[dict]]], list[dict[str, typing.Union[int, str, list[dict]]]], NoneType] = None return_segmentation_masks: typing.Optional[bool] = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[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, list[float], NoneType] = None image_std: typing.Union[float, 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] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None pad_size: typing.Optional[dict[str, int]] = None **kwargs )

参数

  • images (ImageInput) — 要预处理的图像或图像批次。期望单个或批次图像的像素值范围为 0 到 255。如果传入的图像像素值在 0 到 1 之间,请设置 do_rescale=False
  • annotations (AnnotationTypelist[AnnotationType], 可选) — 与图像或图像批次相关的注释列表。如果注释用于目标检测,则注释应为具有以下键的字典:
    • “image_id” (int):图像 ID。
    • “annotations” (list[Dict]):图像的注释列表。每个注释都应为字典。图像可以没有注释,在这种情况下,列表应为空。如果注释用于分割,则注释应为具有以下键的字典:
    • “image_id” (int):图像 ID。
    • “segments_info” (list[Dict]):图像的分割列表。每个分割都应为字典。图像可以没有分割,在这种情况下,列表应为空。
    • “file_name” (str):图像的文件名。
  • return_segmentation_masks (bool, 可选, 默认为 self.return_segmentation_masks) — 是否返回分割掩码。
  • masks_path (strpathlib.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 (floatlist[float], 可选, 默认为 self.image_mean) — 归一化图像时使用的平均值。
  • image_std (floatlist[float], 可选, 默认为 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, list[tuple]] = None ) list[Dict]

参数

  • outputs (DetrObjectDetectionOutput) — 模型的原始输出。
  • threshold (float, 可选) — 保持目标检测预测的分数阈值。
  • target_sizes (torch.Tensorlist[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: typing.Optional[list[tuple[int, int]]] = None ) list[torch.Tensor]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • target_sizes (list[tuple[int, int]], 可选) — 元组列表 (tuple[int, int]),包含批处理中每张图像的目标大小 (height, width)。如果未设置,则不会调整预测的大小。

返回

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[list[tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = 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]]) 对应于每个预测所需的最终大小 (height, width)。如果未设置,则不会调整预测的大小。
  • return_coco_annotation (bool, 可选) — 默认为 False。如果设置为 True,则以 COCO 游程编码 (RLE) 格式返回分割图。

返回

list[Dict]

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

  • segmentation — 形状为 (height, width) 的张量,其中每个像素表示一个 segment_id,如果 return_coco_annotation 设置为 True,则为分割图的 list[List] 游程编码 (RLE)。如果未找到高于 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[set[int]] = None target_sizes: typing.Optional[list[tuple[int, int]]] = None ) list[Dict]

参数

  • 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]]) 对应于批处理中每个预测所需的最终大小 (height, width)。如果未设置,则不会调整预测的大小。

返回

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

class transformers.DetrImageProcessorFast

< >

( **kwargs: typing_extensions.Unpack[transformers.models.detr.image_processing_detr_fast.DetrFastImageProcessorKwargs] )

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

preprocess

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] annotations: typing.Union[dict[str, typing.Union[int, str, list[dict]]], list[dict[str, typing.Union[int, str, list[dict]]]], NoneType] = None masks_path: typing.Union[str, pathlib.Path, NoneType] = None **kwargs: typing_extensions.Unpack[transformers.models.detr.image_processing_detr_fast.DetrFastImageProcessorKwargs] ) <class 'transformers.image_processing_base.BatchFeature'>

参数

  • images (Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]) — 要预处理的图像。期望像素值范围为 0 到 255 的单张或批量图像。如果传入像素值在 0 到 1 之间的图像,请设置 do_rescale=False
  • annotations (AnnotationTypelist[AnnotationType], 可选) — 与图像或图像批次关联的注释列表。如果注释用于对象检测,注释应为包含以下键的字典:
    • “image_id” (int):图像 ID。
    • “annotations” (list[Dict]):图像的注释列表。每个注释应为字典。图像可以没有注释,在这种情况下列表应为空。如果注释用于分割,注释应为包含以下键的字典:
    • “image_id” (int):图像 ID。
    • “segments_info” (list[Dict]):图像的段列表。每个段应为字典。图像可以没有段,在这种情况下列表应为空。
    • “file_name” (str):图像的文件名。
  • masks_path (strpathlib.Path, 可选) — 包含分割掩码的目录路径。
  • do_resize (bool, 可选) — 是否调整图像大小。
  • size (dict[str, int], 可选) — 描述模型的最大输入尺寸。
  • default_to_square (bool, 可选) — 如果 size 为整数,调整大小时是否默认为正方形图像。
  • resample (Union[PILImageResampling, F.InterpolationMode, NoneType]) — 如果调整图像大小,使用的重采样过滤器。可以是枚举 PILImageResampling 之一。仅在 do_resize 设置为 True 时有效。
  • do_center_crop (bool, 可选) — 是否中心裁剪图像。
  • crop_size (dict[str, int], 可选) — 应用 center_crop 后输出图像的大小。
  • do_rescale (bool, 可选) — 是否重新缩放图像。
  • rescale_factor (Union[int, float, NoneType]) — 如果 do_rescale 设置为 True,则按此因子重新缩放图像。
  • do_normalize (bool, 可选) — 是否规范化图像。
  • image_mean (Union[float, list[float], NoneType]) — 用于归一化的图像平均值。仅在 do_normalize 设置为 True 时有效。
  • image_std (Union[float, list[float], NoneType]) — 用于归一化的图像标准差。仅在 do_normalize 设置为 True 时有效。
  • do_convert_rgb (bool, 可选) — 是否将图像转换为 RGB。
  • return_tensors (Union[str, ~utils.generic.TensorType, NoneType]) — 如果设置为 pt,则返回堆叠的张量,否则返回张量列表。
  • data_format (~image_utils.ChannelDimension, 可选) — 仅支持 ChannelDimension.FIRST。为兼容慢速处理器而添加。
  • input_data_format (Union[str, ~image_utils.ChannelDimension, NoneType]) — 输入图像的通道维度格式。如果未设置,则从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像为 (num_channels, height, width) 格式。
    • "channels_last"ChannelDimension.LAST:图像为 (height, width, num_channels) 格式。
    • "none"ChannelDimension.NONE:图像为 (height, width) 格式。
  • device (torch.device, 可选) — 处理图像的设备。如果未设置,则从输入图像推断设备。
  • disable_grouping (bool, 可选) — 是否禁用按大小对图像进行分组,以单独处理它们而不是批量处理。如果为 None,则如果图像在 CPU 上则设置为 True,否则设置为 False。此选择基于经验观察,详情请参阅此处:https://github.com/huggingface/transformers/pull/38157
  • format (str, 可选, 默认为 AnnotationFormat.COCO_DETECTION) — 注释的数据格式。为 "coco_detection" 或 "coco_panoptic" 之一。
  • 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,则图像将填充到批处理中最大的高度和宽度。
  • return_segmentation_masks (bool, 可选, 默认为 False) — 是否返回分割掩码。

返回

<class 'transformers.image_processing_base.BatchFeature'>

  • data (dict) — 由 call 方法返回的列表/数组/张量字典(“pixel_values”等)。
  • tensor_type (Union[None, str, TensorType], 可选) — 您可以在此处提供一个`tensor_type`,以便在初始化时将整数列表转换为PyTorch/TensorFlow/Numpy张量。

post_process_object_detection

< >

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

参数

  • outputs (DetrObjectDetectionOutput) — 模型的原始输出。
  • threshold (float, 可选) — 用于保留对象检测预测的分数阈值。
  • target_sizes (torch.Tensorlist[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: typing.Optional[list[tuple[int, int]]] = None ) list[torch.Tensor]

参数

  • outputs (DetrForSegmentation) — 模型的原始输出。
  • target_sizes (list[tuple[int, int]], 可选) — 元组列表 (tuple[int, int]),包含批处理中每张图像的目标大小 (height, width)。如果未设置,则不会调整预测的大小。

返回

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[list[tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = 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]

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

  • segmentation — 形状为 (height, width) 的张量,其中每个像素表示一个 segment_id,如果 return_coco_annotation 设置为 True,则为分割图的 list[List] 游程编码 (RLE)。如果未找到高于 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[set[int]] = None target_sizes: typing.Optional[list[tuple[int, int]]] = None ) list[Dict]

参数

  • 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_idlabel_ids_to_fuse 中则为 True,否则为 False。同一类别/标签的多个实例已融合并分配了一个单独的 segment_id
    • score — 具有 segment_id 的段的预测分数。

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

DetrFeatureExtractor

class transformers.DetrFeatureExtractor

< >

( *args **kwargs )

__call__

< >

( images **kwargs )

预处理图像或批次图像。

post_process_object_detection

< >

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

参数

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

返回

list[Dict]

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

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

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.Optional[list[tuple[int, int]]] = None ) list[torch.Tensor]

参数

  • outputs (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[list[tuple[int, int]]] = None return_coco_annotation: typing.Optional[bool] = 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]

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

  • segmentation — 形状为 (height, width) 的张量,其中每个像素表示一个 segment_id,如果 return_coco_annotation 设置为 True,则为分割图的 list[List] 游程编码 (RLE)。如果未找到高于 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[set[int]] = None target_sizes: typing.Optional[list[tuple[int, int]]] = None ) list[Dict]

参数

  • 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_idlabel_ids_to_fuse 中则为 True,否则为 False。同一类别/标签的多个实例已融合并分配了一个单独的 segment_id
    • score — 具有 segment_id 的段的预测分数。

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

DETR 特定的输出

class transformers.models.detr.modeling_detr.DetrModelOutput

< >

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

参数

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor) — 模型解码器最后一层输出的隐藏状态序列。
  • past_key_values (~cache_utils.EncoderDecoderCache, 可选, 当传入 use_cache=Trueconfig.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南

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

  • 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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor, 可选) — 模型编码器最后一层输出的隐藏状态序列。
  • 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 后,用于计算自注意力头中的加权平均。

  • intermediate_hidden_states (形状为 (config.decoder_layers, batch_size, sequence_length, hidden_size)torch.FloatTensor, 可选, 当 config.auxiliary_loss=True 时返回) — 中间解码器激活,即每个解码器层的输出,每个都经过层归一化。

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

class transformers.models.detr.modeling_detr.DetrObjectDetectionOutput

< >

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

参数

  • 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) — 所有查询的归一化框坐标,表示为 (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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor, 可选) — 模型解码器最后一层输出的隐藏状态序列。
  • 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)可选,默认为 None) — 模型编码器最后一层输出的隐藏状态序列。
  • 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 之后,用于计算自注意力头中的加权平均。

DetrForObjectDetection 的输出类型。

class transformers.models.detr.modeling_detr.DetrSegmentationOutput

< >

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

参数

  • loss (torch.FloatTensor,形状为 (1,)可选,当提供 labels 时返回) — 总损失,是类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。
  • loss_dict (Dict, 可选) — 包含各个损失的字典。用于日志记录。
  • logits (torch.FloatTensor,形状为 (batch_size, num_queries, num_classes + 1)) — 所有查询的分类对数(包括无对象)。
  • 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)) — 所有查询的分割掩码对数。另请参阅 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)可选,默认为 None) — 模型编码器最后一层输出的隐藏状态序列。
  • 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 的输出类型。

DetrModel

class 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,形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • pixel_mask (torch.LongTensor,形状为 (batch_size, height, width)可选) — 掩码,用于避免对填充像素值执行注意力。掩码值选择在 [0, 1] 之间:

    • 1 表示真实像素(即未被遮蔽),
    • 0 表示填充像素(即被遮蔽)。

    什么是注意力掩码?

  • decoder_attention_mask (torch.FloatTensor,形状为 (batch_size, num_queries)可选) — 默认情况下不使用。可用于遮蔽对象查询。
  • encoder_outputs (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.DetrModelOutputtuple(torch.FloatTensor)

一个 transformers.models.detr.modeling_detr.DetrModelOutput 或一个 torch.FloatTensor 元组(如果传入 return_dict=Falseconfig.return_dict=False),包含根据配置 (DetrConfig) 和输入而变化的各种元素。

  • last_hidden_state (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

  • past_key_values (~cache_utils.EncoderDecoderCache, 可选, 当传入 use_cache=Trueconfig.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南

    包含预先计算的隐藏状态(自注意力块中的键和值,如果 config.is_encoder_decoder=True,则可选地包含交叉注意力块中的键和值),可用于(参见 past_key_values 输入)加速序列解码。

  • 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 之后,用于计算自注意力头中的加权平均。

  • 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

class transformers.DetrForObjectDetection

< >

( config: DetrConfig )

参数

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

带有目标检测头(用于 COCO 检测等任务)的 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 labels: typing.Optional[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,形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • pixel_mask (torch.LongTensor,形状为 (batch_size, height, width)可选) — 掩码,用于避免对填充像素值执行注意力。掩码值选择在 [0, 1] 之间:

    • 1 表示真实像素(即未被遮蔽),
    • 0 表示填充像素(即被遮蔽)。

    什么是注意力掩码?

  • decoder_attention_mask (torch.FloatTensor,形状为 (batch_size, num_queries)可选) — 默认不使用。可用于遮蔽对象查询。
  • encoder_outputs (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)可选) — 可选地,除了用全零张量初始化查询外,您还可以选择直接传递嵌入表示。
  • labels (list[Dict],长度为 (batch_size,)可选) — 用于计算二分匹配损失的标签。字典列表,每个字典至少包含以下两个键:‘class_labels’ 和 ‘boxes’(分别是批处理中图像的类别标签和边界框)。类别标签本身应为 torch.LongTensor,长度为 (图像中边界框的数量,),边界框应为 torch.FloatTensor,形状为 (图像中边界框的数量, 4)
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的 `hidden_states`。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 对象而不是普通元组。

返回

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

一个 transformers.models.detr.modeling_detr.DetrObjectDetectionOutput 对象或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.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) — 所有查询的标准化框坐标,表示为 (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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 模型解码器最后一层输出的隐藏状态序列。

  • 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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选,默认为 None) — 模型编码器最后一层输出的隐藏状态序列。

  • 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 之后,用于计算自注意力头中的加权平均。

DetrForObjectDetection forward 方法,覆盖了 __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

class 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[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 (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获取。有关详细信息,请参见 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 进行图像处理)。
  • pixel_mask (形状为 (batch_size, height, width)torch.LongTensor可选) — 用于避免对填充像素值执行注意力的掩码。掩码值选择范围为 [0, 1]

    • 1 表示真实像素(即未被掩码),
    • 0 表示填充像素(即被掩码)。

    什么是注意力掩码?

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

返回

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

一个 transformers.models.detr.modeling_detr.DetrSegmentationOutput 对象或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.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) — 所有查询的标准化框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内标准化,相对于批次中每个单独图像的大小(忽略可能的填充)。您可以使用 post_process_object_detection() 来检索未标准化的边界框。

  • pred_masks (形状为 (batch_size, num_queries, height/4, width/4)torch.FloatTensor) — 所有查询的分割掩码 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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 模型解码器最后一层输出的隐藏状态序列。

  • 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 (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选,默认为 None) — 模型编码器最后一层输出的隐藏状态序列。

  • 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 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 上更新