Transformers 文档
D-FINE
并获得增强的文档体验
开始使用
D-FINE
概述
D-FINE 模型由 Yansong Peng、Hebei Li、Peixi Wu、Yueyi Zhang、Xiaoyan Sun 和 Feng Wu 在 D-FINE: Redefine Regression Task in DETRs as Fine-grained Distribution Refinement 一文中提出。
论文摘要如下:
我们介绍了 D-FINE,这是一款强大的实时目标检测器,通过重新定义 DETR 模型中的边界框回归任务,实现了出色的定位精度。D-FINE 包含两个关键组件:细粒度分布细化 (FDR) 和全局最优定位自蒸馏 (GO-LSD)。FDR 将回归过程从预测固定坐标转变为迭代细化概率分布,提供了一种细粒度的中间表示,显著提高了定位准确性。GO-LSD 是一种双向优化策略,通过自蒸馏将精炼分布的定位知识传递到较浅的层,同时简化了深层网络的残差预测任务。此外,D-FINE 在计算密集型模块和操作中融入了轻量级优化,实现了速度与准确性之间的更佳平衡。具体来说,D-FINE-L / X 在 COCO 数据集上实现了 54.0% / 55.8% 的 AP,在 NVIDIA T4 GPU 上的运行速度为 124 / 78 FPS。在 Objects365 上进行预训练后,D-FINE-L / X 达到了 57.1% / 59.3% 的 AP,超过了所有现有的实时检测器。此外,我们的方法显著提升了各种 DETR 模型的性能,最多可提高 5.3% 的 AP,而附加的参数和训练成本可以忽略不计。我们的代码和预训练模型:请访问此 URL。
该模型由 VladOS95-cyber 贡献。原始代码可在此处找到。
使用技巧
>>> import torch
>>> from transformers.image_utils import load_image
>>> from transformers import DFineForObjectDetection, AutoImageProcessor
>>> url = 'http://images.cocodataset.org/val2017/000000039769.jpg'
>>> image = load_image(url)
>>> image_processor = AutoImageProcessor.from_pretrained("ustc-community/dfine_x_coco")
>>> model = DFineForObjectDetection.from_pretrained("ustc-community/dfine_x_coco")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> results = image_processor.post_process_object_detection(outputs, target_sizes=[(image.height, image.width)], threshold=0.5)
>>> for result in results:
... for score, label_id, box in zip(result["scores"], result["labels"], result["boxes"]):
... score, label = score.item(), label_id.item()
... box = [round(i, 2) for i in box.tolist()]
... print(f"{model.config.id2label[label]}: {score:.2f} {box}")
cat: 0.96 [344.49, 23.4, 639.84, 374.27]
cat: 0.96 [11.71, 53.52, 316.64, 472.33]
remote: 0.95 [40.46, 73.7, 175.62, 117.57]
sofa: 0.92 [0.59, 1.88, 640.25, 474.74]
remote: 0.89 [333.48, 77.04, 370.77, 187.3]
DFineConfig
class transformers.DFineConfig
< 源 >( initializer_range = 0.01 initializer_bias_prior_prob = None layer_norm_eps = 1e-05 batch_norm_eps = 1e-05 backbone_config = None backbone = None use_pretrained_backbone = False use_timm_backbone = False freeze_backbone_batch_norms = True backbone_kwargs = None encoder_hidden_dim = 256 encoder_in_channels = [512, 1024, 2048] feat_strides = [8, 16, 32] encoder_layers = 1 encoder_ffn_dim = 1024 encoder_attention_heads = 8 dropout = 0.0 activation_dropout = 0.0 encode_proj_layers = [2] positional_encoding_temperature = 10000 encoder_activation_function = 'gelu' activation_function = 'silu' eval_size = None normalize_before = False hidden_expansion = 1.0 d_model = 256 num_queries = 300 decoder_in_channels = [256, 256, 256] decoder_ffn_dim = 1024 num_feature_levels = 3 decoder_n_points = 4 decoder_layers = 6 decoder_attention_heads = 8 decoder_activation_function = 'relu' attention_dropout = 0.0 num_denoising = 100 label_noise_ratio = 0.5 box_noise_scale = 1.0 learn_initial_query = False anchor_image_size = None with_box_refine = True is_encoder_decoder = True matcher_alpha = 0.25 matcher_gamma = 2.0 matcher_class_cost = 2.0 matcher_bbox_cost = 5.0 matcher_giou_cost = 2.0 use_focal_loss = True auxiliary_loss = True focal_loss_alpha = 0.75 focal_loss_gamma = 2.0 weight_loss_vfl = 1.0 weight_loss_bbox = 5.0 weight_loss_giou = 2.0 weight_loss_fgl = 0.15 weight_loss_ddf = 1.5 eos_coefficient = 0.0001 eval_idx = -1 layer_scale = 1 max_num_bins = 32 reg_scale = 4.0 depth_mult = 1.0 top_prob_values = 4 lqe_hidden_dim = 64 lqe_layers = 2 decoder_offset_scale = 0.5 decoder_method = 'default' up = 0.5 **kwargs )
参数
- initializer_range (
float
, 可选, 默认为 0.01) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - initializer_bias_prior_prob (
float
, 可选) — 偏置初始化器用于初始化 `enc_score_head` 和 `class_embed` 偏置的先验概率。如果为 `None`,则在初始化模型权重时计算 `prior_prob = 1 / (num_labels + 1)`。 - layer_norm_eps (
float
, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。 - batch_norm_eps (
float
, 可选, 默认为 1e-05) — 批量归一化层使用的 epsilon 值。 - backbone_config (
Dict
, 可选, 默认为RTDetrResNetConfig()
) — 主干模型的配置。 - backbone (
str
, 可选) — 当 `backbone_config` 为 `None` 时使用的主干名称。如果 `use_pretrained_backbone` 为 `True`,将从 timm 或 transformers 库中加载相应的预训练权重。如果 `use_pretrained_backbone` 为 `False`,将加载主干的配置并用其初始化随机权重的主干。 - use_pretrained_backbone (
bool
, 可选, 默认为False
) — 是否为主干使用预训练权重。 - use_timm_backbone (
bool
, 可选, 默认为False
) — 是否从 timm 库加载 `backbone`。如果为 `False`,则从 transformers 库加载主干。 - freeze_backbone_batch_norms (
bool
, 可选, 默认为True
) — 是否冻结主干中的批量归一化层。 - backbone_kwargs (
dict
, 可选) — 从检查点加载时传递给 AutoBackbone 的关键字参数,例如 `{'out_indices': (0, 1, 2, 3)}`。如果设置了 `backbone_config`,则不能指定此项。 - encoder_hidden_dim (
int
, 可选, 默认为 256) — 混合编码器中层的维度。 - encoder_in_channels (
list
, 可选, 默认为 `[512, 1024, 2048]`) — 编码器的多级特征输入。 - feat_strides (
list[int]
, 可选, 默认为[8, 16, 32]
) — 每个特征图使用的步幅。 - encoder_layers (
int
, 可选, 默认为 1) — 编码器使用的总层数。 - encoder_ffn_dim (
int
, 可选, 默认为 1024) — 解码器中“中间”(通常称为前馈)层的维度。 - encoder_attention_heads (
int
, 可选, 默认为 8) — Transformer 编码器中每个注意力层的注意力头数。 - dropout (
float
, 可选, 默认为 0.0) — 所有 dropout 层的比例。 - activation_dropout (
float
, 可选, 默认为 0.0) — 全连接层内激活函数的 dropout 比例。 - encode_proj_layers (
list[int]
, 可选, 默认为[2]
) — 编码器中要使用的投影层的索引。 - positional_encoding_temperature (
int
, 可选, 默认为 10000) — 用于创建位置编码的温度参数。 - encoder_activation_function (
str
, 可选, 默认为"gelu"
) — 编码器和池化层中的非线性激活函数(函数或字符串)。如果为字符串,支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - activation_function (
str
, 可选, 默认为"silu"
) — 通用层中的非线性激活函数(函数或字符串)。如果为字符串,支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - eval_size (
tuple[int, int]
, 可选) — 考虑步幅后,用于计算位置嵌入有效高度和宽度的尺寸。 - normalize_before (
bool
, 可选, 默认为False
) — 决定是否在自注意力和前馈模块之前,在 transformer 编码器层中应用层归一化。 - hidden_expansion (
float
, 可选, 默认为 1.0) — 用于扩大 RepVGGBlock 和 CSPRepLayer 维度大小的扩展比率。 - d_model (
int
, 可选, 默认为 256) — 除混合编码器外各层的维度。 - num_queries (
int
, 可选, 默认为 300) — 对象查询的数量。 - decoder_in_channels (
list
, 可选, 默认为[256, 256, 256]
) — 解码器的多级特征维度 - decoder_ffn_dim (
int
, 可选, 默认为 1024) — 解码器中“中间”(通常称为前馈)层的维度。 - num_feature_levels (
int
, 可选, 默认为 3) — 输入特征级别的数量。 - decoder_n_points (
int
, optional, defaults to 4) — 解码器中每个注意力头在每个特征级别中采样的键的数量。 - decoder_layers (
int
, optional, defaults to 6) — 解码器层数。 - decoder_attention_heads (
int
, optional, defaults to 8) — Transformer 解码器中每个注意力层的注意力头数量。 - decoder_activation_function (
str
, optional, defaults to"relu"
) — 解码器中的非线性激活函数(函数或字符串)。如果为字符串,支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - attention_dropout (
float
, optional, defaults to 0.0) — 注意力概率的丢弃率。 - num_denoising (
int
, optional, defaults to 100) — 用于对比去噪的总去噪任务或查询数量。 - label_noise_ratio (
float
, optional, defaults to 0.5) — 应添加随机噪声的去噪标签的比例。 - box_noise_scale (
float
, optional, defaults to 1.0) — 添加到边界框的噪声的尺度或幅度。 - learn_initial_query (
bool
, optional, defaults toFalse
) — 指示是否应在训练期间学习解码器的初始查询嵌入。 - anchor_image_size (
tuple[int, int]
, optional) — 在评估期间用于生成边界框锚点的输入图像的高度和宽度。如果为 None,则应用自动生成锚点。 - with_box_refine (
bool
, optional, defaults toTrue
) — 是否应用迭代式边界框细化,其中每个解码器层根据前一层的预测来细化边界框。 - is_encoder_decoder (
bool
, optional, defaults toTrue
) — 架构是否为编码器-解码器结构。 - matcher_alpha (
float
, optional, defaults to 0.25) — 匈牙利匹配器使用的参数 alpha。 - matcher_gamma (
float
, optional, defaults to 2.0) — 匈牙利匹配器使用的参数 gamma。 - matcher_class_cost (
float
, optional, defaults to 2.0) — 匈牙利匹配器使用的分类损失的相对权重。 - matcher_bbox_cost (
float
, optional, defaults to 5.0) — 匈牙利匹配器使用的边界框损失的相对权重。 - matcher_giou_cost (
float
, optional, defaults to 2.0) — 匈牙利匹配器使用的 giou 损失的相对权重。 - use_focal_loss (
bool
, optional, defaults toTrue
) — 指示是否使用 focal loss 的参数。 - auxiliary_loss (
bool
, optional, defaults toTrue
) — 是否使用辅助解码损失(每个解码器层的损失)。 - focal_loss_alpha (
float
, optional, defaults to 0.75) — 用于计算 focal loss 的参数 alpha。 - focal_loss_gamma (
float
, optional, defaults to 2.0) — 用于计算 focal loss 的参数 gamma。 - weight_loss_vfl (
float
, optional, defaults to 1.0) — 目标检测损失中 Varifocal 损失的相对权重。 - weight_loss_bbox (
float
, optional, defaults to 5.0) — 目标检测损失中 L1 边界框损失的相对权重。 - weight_loss_giou (
float
, optional, defaults to 2.0) — 目标检测损失中广义 IoU 损失的相对权重。 - weight_loss_fgl (
float
, optional, defaults to 0.15) — 目标检测损失中细粒度定位损失的相对权重。 - weight_loss_ddf (
float
, optional, defaults to 1.5) — 目标检测损失中解耦蒸馏 focal loss 的相对权重。 - eos_coefficient (
float
, optional, defaults to 0.0001) — 目标检测损失中“无目标”类别的相对分类权重。 - eval_idx (
int
, optional, defaults to -1) — 用于评估的解码器层的索引。如果为负数,则从末尾开始计数(例如,-1 表示使用最后一层)。这允许在解码器堆栈中进行早期预测,同时仍然训练后续层。 - layer_scale (
float
, optional, defaults to1.0
) — 后续解码器层中隐藏维度的缩放因子。用于在评估层之后调整模型容量。 - max_num_bins (
int
, optional, defaults to 32) — 分布引导的边界框细化的最大箱数。更高的值允许更细粒度的定位,但会增加计算量。 - reg_scale (
float
, optional, defaults to 4.0) — 回归分布的缩放因子。控制边界框细化过程的范围和粒度。 - depth_mult (
float
, optional, defaults to 1.0) — RepNCSPELAN4 层中块数量的乘数。用于在保持其架构的同时缩放模型的深度。 - top_prob_values (
int
, optional, defaults to 4) — 从每个角的分布中考虑的最高概率值的数量。 - lqe_hidden_dim (
int
, optional, defaults to 64) — 位置质量估计器(LQE)网络的隐藏维度大小。 - lqe_layers (
int
, optional, defaults to 2) — 位置质量估计器 MLP 中的层数。 - decoder_offset_scale (
float
, optional, defaults to 0.5) — 在可变形注意力中使用的偏移尺度。 - decoder_method (
str
, optional, defaults to"default"
) — 解码器使用的方法:"default"
或"discrete"
。 - up (
float
, optional, defaults to 0.5) — 控制加权函数的上界。
这是用于存储 DFineModel 配置的配置类。它根据指定的参数实例化一个 D-FINE 模型,定义模型架构。使用默认值实例化配置将产生与 D-FINE-X-COCO "ustc-community/dfine-xlarge-coco” 相似的配置。配置对象继承自 PretrainedConfig,可用于控制模型输出。请阅读 PretrainedConfig 的文档以获取更多信息。
from_backbone_configs
< 源代码 >( backbone_config: PretrainedConfig **kwargs ) → DFineConfig
从预训练的主干模型配置和 DETR 模型配置中实例化一个 DFineConfig(或其派生类)。
DFineModel
class transformers.DFineModel
< 源代码 >( config: DFineConfig )
参数
- config (DFineConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
RT-DETR 模型(由主干网络和编码器-解码器组成),输出原始的隐藏状态,顶部没有任何 head。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪 head 等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( pixel_values: FloatTensor pixel_mask: typing.Optional[torch.LongTensor] = 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.d_fine.modeling_d_fine.DFineModelOutput
或 tuple(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 表示填充的像素(即 被掩码)。
- 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,)
,可选) — 用于计算二分匹配损失的标签。字典列表,每个字典至少包含以下 2 个键:‘class_labels’ 和 ‘boxes’(分别是批次中图像的类别标签和边界框)。类别标签本身应为长度为(图像中边界框数量,)
的torch.LongTensor
,边界框应为形状为(图像中边界框数量, 4)
的torch.FloatTensor
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.models.d_fine.modeling_d_fine.DFineModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.d_fine.modeling_d_fine.DFineModelOutput
或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含各种元素,具体取决于配置(DFineConfig)和输入。
-
last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, num_queries, hidden_size)
) — 模型解码器最后一层输出的隐藏状态序列。 -
intermediate_hidden_states (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, hidden_size)
) — 堆叠的中间隐藏状态(解码器每层的输出)。 -
intermediate_logits (
torch.FloatTensor
,形状为(batch_size, config.decoder_layers, sequence_length, config.num_labels)
) — 堆叠的中间 logits(解码器每一层的 logits)。 -
intermediate_reference_points (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间参考点(解码器每层的参考点)。 -
intermediate_predicted_corners (
torch.FloatTensor
,形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间预测角点(解码器每一层的预测角点)。 -
initial_reference_points (
torch.FloatTensor
,形状为(batch_size, num_queries, 4)
) — 用于第一个解码器层的初始参考点。 -
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)
,可选,默认为None
) — 模型编码器最后一层输出的隐藏状态序列。 -
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 之后,用于计算自注意力头中的加权平均。
-
init_reference_points (
torch.FloatTensor
, 形状为(batch_size, num_queries, 4)
) — 通过 Transformer 解码器发送的初始参考点。 -
enc_topk_logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
) — 预测的边界框分数,其中得分最高的config.two_stage_num_proposals
个边界框被选为编码器阶段的区域提议。边界框二元分类(即前景和背景)的输出。 -
enc_topk_bboxes (
torch.FloatTensor
,形状为(batch_size, sequence_length, 4)
) — 编码器阶段预测的边界框坐标的 logits。 -
enc_outputs_class (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
,可选,当config.with_box_refine=True
和config.two_stage=True
时返回) — 预测的边界框分数,其中得分最高的config.two_stage_num_proposals
个边界框被选为第一阶段的区域提议。边界框二元分类(即前景和背景)的输出。 -
enc_outputs_coord_logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, 4)
,可选,当config.with_box_refine=True
和config.two_stage=True
时返回) — 第一阶段预测的边界框坐标的 logits。 -
denoising_meta_values (
dict
,可选,默认为None
) — 用于去噪相关值的额外字典。
DFineModel 的 forward 方法,覆盖了 __call__
特殊方法。
虽然前向传播的流程需要在此函数中定义,但之后应该调用 `Module` 实例而不是这个函数,因为前者会处理运行前处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, DFineModel
>>> 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("PekingU/DFine_r50vd")
>>> model = DFineModel.from_pretrained("PekingU/DFine_r50vd")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 300, 256]
DFineForObjectDetection
class transformers.DFineForObjectDetection
< 源代码 >( config: DFineConfig )
参数
- config (DFineConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
RT-DETR 模型(由主干网络和编码器-解码器组成),输出边界框和 logits,以便进一步解码为分数和类别。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪 head 等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( pixel_values: FloatTensor pixel_mask: typing.Optional[torch.LongTensor] = 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 **loss_kwargs ) → transformers.models.d_fine.modeling_d_fine.DFineObjectDetectionOutput
或 tuple(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 表示填充的像素 (即**被遮盖**)。
- 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,)
,*可选*) — 用于计算二分匹配损失的标签。一个字典列表,每个字典至少包含以下 2 个键:‘class_labels’ 和 ‘boxes’(分别是一个批次中图像的类别标签和边界框)。类别标签本身应该是一个长度为(图像中边界框的数量,)
的torch.LongTensor
,而边界框应该是一个形状为(图像中边界框的数量, 4)
的torch.FloatTensor
。 - output_attentions (
bool
,*可选*) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
,*可选*) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
,*可选*) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.d_fine.modeling_d_fine.DFineObjectDetectionOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.d_fine.modeling_d_fine.DFineObjectDetectionOutput
或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置 (DFineConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor
,形状为(1,)
,*可选*,在提供labels
时返回) — 总损失,是用于类别预测的负对数似然(交叉熵)和边界框损失的线性组合。后者定义为 L1 损失和广义尺度不变 IoU 损失的线性组合。 -
loss_dict (
Dict
, 可选) — 包含各个损失的字典。用于日志记录。 -
logits (形状为
(batch_size, num_queries, num_classes + 1)
的torch.FloatTensor
) — 所有查询的分类 logits(包括无对象)。 -
pred_boxes (
torch.FloatTensor
,形状为(batch_size, num_queries, 4)
) — 所有查询的归一化边界框坐标,表示为 (center_x, center_y, width, height)。这些值在 [0, 1] 范围内归一化,相对于批次中每个单独图像的大小(不考虑可能的填充)。你可以使用~DFineImageProcessor.post_process_object_detection
来检索未归一化(绝对)的边界框。 -
auxiliary_outputs (
list[Dict]
,*可选*) — 可选,仅在激活辅助损失(即config.auxiliary_loss
设置为True
)并提供标签时返回。它是一个字典列表,包含每个解码器层的上述两个键(logits
和pred_boxes
)。 -
last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, num_queries, hidden_size)
) — 模型解码器最后一层输出的隐藏状态序列。 -
intermediate_hidden_states (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, hidden_size)
) — 堆叠的中间隐藏状态(解码器每层的输出)。 -
intermediate_logits (
torch.FloatTensor
,形状为(batch_size, config.decoder_layers, num_queries, config.num_labels)
) — 堆叠的中间 logits(解码器每一层的 logits)。 -
intermediate_reference_points (
torch.FloatTensor
, 形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间参考点(解码器每层的参考点)。 -
intermediate_predicted_corners (
torch.FloatTensor
,形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的中间预测角点(解码器每一层的预测角点)。 -
initial_reference_points (
torch.FloatTensor
,形状为(batch_size, config.decoder_layers, num_queries, 4)
) — 堆叠的初始参考点(解码器每一层的初始参考点)。 -
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)
,可选,默认为None
) — 模型编码器最后一层输出的隐藏状态序列。 -
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 之后,用于计算自注意力头中的加权平均。
-
init_reference_points (
torch.FloatTensor
, 形状为(batch_size, num_queries, 4)
) — 通过 Transformer 解码器发送的初始参考点。 -
enc_topk_logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
,*可选*,当config.with_box_refine=True
和config.two_stage=True
时返回) — 编码器中预测的边界框坐标的 logits。 -
enc_topk_bboxes (
torch.FloatTensor
,形状为(batch_size, sequence_length, 4)
,*可选*,当config.with_box_refine=True
和config.two_stage=True
时返回) — 编码器中预测的边界框坐标的 logits。 -
enc_outputs_class (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
,可选,当config.with_box_refine=True
和config.two_stage=True
时返回) — 预测的边界框分数,其中得分最高的config.two_stage_num_proposals
个边界框被选为第一阶段的区域提议。边界框二元分类(即前景和背景)的输出。 -
enc_outputs_coord_logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, 4)
,可选,当config.with_box_refine=True
和config.two_stage=True
时返回) — 第一阶段预测的边界框坐标的 logits。 -
denoising_meta_values (
dict
,*可选*,默认为None
) — 用于去噪相关值的额外字典
DFineForObjectDetection 的 forward 方法覆盖了 __call__
特殊方法。
虽然前向传播的流程需要在此函数中定义,但之后应该调用 `Module` 实例而不是这个函数,因为前者会处理运行前处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> import torch
>>> from transformers.image_utils import load_image
>>> from transformers import AutoImageProcessor, DFineForObjectDetection
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = load_image(url)
>>> image_processor = AutoImageProcessor.from_pretrained("ustc-community/dfine-xlarge-coco")
>>> model = DFineForObjectDetection.from_pretrained("ustc-community/dfine-xlarge-coco")
>>> # prepare image for the model
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> # forward pass
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> list(logits.shape)
[1, 300, 80]
>>> boxes = outputs.pred_boxes
>>> list(boxes.shape)
[1, 300, 4]
>>> # 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)
>>> result = results[0] # first image in batch
>>> for score, label, box in zip(result["scores"], result["labels"], result["boxes"]):
... box = [round(i, 2) for i in box.tolist()]
... print(
... f"Detected {model.config.id2label[label.item()]} with confidence "
... f"{round(score.item(), 3)} at location {box}"
... )
Detected cat with confidence 0.958 at location [344.49, 23.4, 639.84, 374.27]
Detected cat with confidence 0.956 at location [11.71, 53.52, 316.64, 472.33]
Detected remote with confidence 0.947 at location [40.46, 73.7, 175.62, 117.57]
Detected sofa with confidence 0.918 at location [0.59, 1.88, 640.25, 474.74]