# Copyright (c) Meta Platforms, Inc. and affiliates. # # This software may be used and distributed in accordance with # the terms of the DINOv3 License Agreement. # ------------------------------------------------------------------------ # Plain-DETR # Copyright (c) 2023 Xi'an Jiaotong University & Microsoft Research Asia. # Licensed under The MIT License [see LICENSE for details] # ------------------------------------------------------------------------ # Deformable DETR # Copyright (c) 2020 SenseTime. All Rights Reserved. # Licensed under the Apache License, Version 2.0 [see LICENSE for details] # ------------------------------------------------------------------------ # Modified from DETR (https://github.com/facebookresearch/detr) # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved # ------------------------------------------------------------------------ """ Deformable DETR model and criterion classes. """ import math import torch import torch.nn.functional as F from torch import nn from ..util import box_ops from ..util.misc import NestedTensor, _get_clones, inverse_sigmoid, nested_tensor_from_tensor_list from .backbone import build_backbone from .transformer import build_transformer class PlainDETR(nn.Module): """This is the Deformable DETR module that performs object detection""" def __init__( self, backbone, transformer, num_classes, num_feature_levels, aux_loss=True, with_box_refine=False, two_stage=False, num_queries_one2one=300, num_queries_one2many=0, mixed_selection=False, ): """Initializes the model. Parameters: backbone: torch module of the backbone to be used. See backbone.py transformer: torch module of the transformer architecture. See transformer.py num_classes: number of object classes aux_loss: True if auxiliary decoding losses (loss at each decoder layer) are to be used. with_box_refine: iterative bounding box refinement two_stage: two-stage Deformable DETR num_queries_one2one: number of object queries for one-to-one matching part num_queries_one2many: number of object queries for one-to-many matching part mixed_selection: a trick for Deformable DETR two stage """ super().__init__() num_queries = num_queries_one2one + num_queries_one2many self.num_queries = num_queries self.transformer = transformer hidden_dim = transformer.d_model self.class_embed = nn.Linear(hidden_dim, num_classes) self.bbox_embed = MLP(hidden_dim, hidden_dim, 4, 3) self.num_feature_levels = num_feature_levels if not two_stage: self.query_embed = nn.Embedding(num_queries, hidden_dim * 2) elif mixed_selection: self.query_embed = nn.Embedding(num_queries, hidden_dim) self.input_proj = nn.ModuleList( [ nn.Sequential( nn.Conv2d(backbone.num_channels[0], hidden_dim, kernel_size=1), nn.GroupNorm(32, hidden_dim), ) ] ) self.backbone = backbone self.aux_loss = aux_loss self.with_box_refine = with_box_refine self.two_stage = two_stage prior_prob = 0.01 bias_value = -math.log((1 - prior_prob) / prior_prob) self.class_embed.bias.data = torch.ones(num_classes) * bias_value nn.init.constant_(self.bbox_embed.layers[-1].weight.data, 0) nn.init.constant_(self.bbox_embed.layers[-1].bias.data, 0) for proj in self.input_proj: nn.init.xavier_uniform_(proj[0].weight, gain=1) nn.init.constant_(proj[0].bias, 0) # if two-stage, the last class_embed and bbox_embed is for region proposal generation num_pred = (transformer.decoder.num_layers + 1) if two_stage else transformer.decoder.num_layers if with_box_refine: self.class_embed = _get_clones(self.class_embed, num_pred) self.bbox_embed = _get_clones(self.bbox_embed, num_pred) nn.init.constant_(self.bbox_embed[0].layers[-1].bias.data[2:], -2.0) # hack implementation for iterative bounding box refinement self.transformer.decoder.bbox_embed = self.bbox_embed else: nn.init.constant_(self.bbox_embed.layers[-1].bias.data[2:], -2.0) self.class_embed = nn.ModuleList([self.class_embed for _ in range(num_pred)]) self.bbox_embed = nn.ModuleList([self.bbox_embed for _ in range(num_pred)]) self.transformer.decoder.bbox_embed = None if two_stage: # hack implementation for two-stage self.transformer.decoder.class_embed = self.class_embed for box_embed in self.bbox_embed: nn.init.constant_(box_embed.layers[-1].bias.data[2:], 0.0) self.num_queries_one2one = num_queries_one2one self.mixed_selection = mixed_selection def forward(self, samples: NestedTensor): """The forward expects a NestedTensor, which consists of: - samples.tensor: batched images, of shape [batch_size x 3 x H x W] - samples.mask: a binary mask of shape [batch_size x H x W], containing 1 on padded pixels It returns a dict with the following elements: - "pred_logits": the classification logits (including no-object) for all queries. Shape= [batch_size x num_queries x (num_classes + 1)] - "pred_boxes": The normalized boxes coordinates for all queries, represented as (center_x, center_y, height, width). These values are normalized in [0, 1], relative to the size of each individual image (disregarding possible padding). See PostProcess for information on how to retrieve the unnormalized bounding box. - "aux_outputs": Optional, only returned when auxilary losses are activated. It is a list of dictionnaries containing the two above keys for each decoder layer. """ if not isinstance(samples, NestedTensor): samples = nested_tensor_from_tensor_list(samples) features, pos = self.backbone(samples) srcs = [] masks = [] for layer, feat in enumerate(features): src, mask = feat.decompose() srcs.append(self.input_proj[layer](src)) masks.append(mask) assert mask is not None query_embeds = None if not self.two_stage or self.mixed_selection: query_embeds = self.query_embed.weight[0 : self.num_queries, :] # make attn mask """ attention mask to prevent information leakage """ self_attn_mask = torch.zeros( [ self.num_queries, self.num_queries, ], dtype=bool, device=src.device, ) self_attn_mask[ self.num_queries_one2one :, 0 : self.num_queries_one2one, ] = True self_attn_mask[ 0 : self.num_queries_one2one, self.num_queries_one2one :, ] = True ( hs, init_reference, inter_references, enc_outputs_class, enc_outputs_coord_unact, enc_outputs_delta, output_proposals, max_shape, ) = self.transformer(srcs, masks, pos, query_embeds, self_attn_mask) outputs_classes_one2one = [] outputs_coords_one2one = [] outputs_classes_one2many = [] outputs_coords_one2many = [] for lvl in range(hs.shape[0]): if lvl == 0: reference = init_reference else: reference = inter_references[lvl - 1] reference = inverse_sigmoid(reference) outputs_class = self.class_embed[lvl](hs[lvl]) tmp = self.bbox_embed[lvl](hs[lvl]) if reference.shape[-1] == 4: tmp += reference else: assert reference.shape[-1] == 2 tmp[..., :2] += reference outputs_coord = tmp.sigmoid() outputs_classes_one2one.append(outputs_class[:, 0 : self.num_queries_one2one]) outputs_classes_one2many.append(outputs_class[:, self.num_queries_one2one :]) outputs_coords_one2one.append(outputs_coord[:, 0 : self.num_queries_one2one]) outputs_coords_one2many.append(outputs_coord[:, self.num_queries_one2one :]) outputs_classes_one2one = torch.stack(outputs_classes_one2one) outputs_coords_one2one = torch.stack(outputs_coords_one2one) outputs_classes_one2many = torch.stack(outputs_classes_one2many) outputs_coords_one2many = torch.stack(outputs_coords_one2many) out = { "pred_logits": outputs_classes_one2one[-1], "pred_boxes": outputs_coords_one2one[-1], "pred_logits_one2many": outputs_classes_one2many[-1], "pred_boxes_one2many": outputs_coords_one2many[-1], } if self.aux_loss: out["aux_outputs"] = self._set_aux_loss(outputs_classes_one2one, outputs_coords_one2one) out["aux_outputs_one2many"] = self._set_aux_loss(outputs_classes_one2many, outputs_coords_one2many) if self.two_stage: enc_outputs_coord = enc_outputs_coord_unact.sigmoid() out["enc_outputs"] = { "pred_logits": enc_outputs_class, "pred_boxes": enc_outputs_coord, } return out @torch.jit.unused def _set_aux_loss(self, outputs_class, outputs_coord): # this is a workaround to make torchscript happy, as torchscript # doesn't support dictionary with non-homogeneous values, such # as a dict having both a Tensor and a list. return [{"pred_logits": a, "pred_boxes": b} for a, b in zip(outputs_class[:-1], outputs_coord[:-1])] class PlainDETRReParam(PlainDETR): def forward(self, samples: NestedTensor): """The forward expects a NestedTensor, which consists of: - samples.tensor: batched images, of shape [batch_size x 3 x H x W] - samples.mask: a binary mask of shape [batch_size x H x W], containing 1 on padded pixels It returns a dict with the following elements: - "pred_logits": the classification logits (including no-object) for all queries. Shape= [batch_size x num_queries x (num_classes + 1)] - "pred_boxes": The normalized boxes coordinates for all queries, represented as (center_x, center_y, height, width). These values are normalized in [0, 1], relative to the size of each individual image (disregarding possible padding). See PostProcess for information on how to retrieve the unnormalized bounding box. - "aux_outputs": Optional, only returned when auxilary losses are activated. It is a list of dictionnaries containing the two above keys for each decoder layer. """ if not isinstance(samples, NestedTensor): samples = nested_tensor_from_tensor_list(samples) features, pos = self.backbone(samples) srcs = [] masks = [] for layer, feat in enumerate(features): src, mask = feat.decompose() srcs.append(self.input_proj[layer](src)) masks.append(mask) assert mask is not None query_embeds = None if not self.two_stage or self.mixed_selection: query_embeds = self.query_embed.weight[0 : self.num_queries, :] # make attn mask """ attention mask to prevent information leakage """ self_attn_mask = torch.zeros( [ self.num_queries, self.num_queries, ], dtype=bool, device=src.device, ) self_attn_mask[ self.num_queries_one2one :, 0 : self.num_queries_one2one, ] = True self_attn_mask[ 0 : self.num_queries_one2one, self.num_queries_one2one :, ] = True ( hs, init_reference, inter_references, enc_outputs_class, enc_outputs_coord_unact, enc_outputs_delta, output_proposals, max_shape, ) = self.transformer(srcs, masks, pos, query_embeds, self_attn_mask) outputs_classes_one2one = [] outputs_coords_one2one = [] outputs_classes_one2many = [] outputs_coords_one2many = [] outputs_coords_old_one2one = [] outputs_deltas_one2one = [] outputs_coords_old_one2many = [] outputs_deltas_one2many = [] for lvl in range(hs.shape[0]): if lvl == 0: reference = init_reference else: reference = inter_references[lvl - 1] outputs_class = self.class_embed[lvl](hs[lvl]) tmp = self.bbox_embed[lvl](hs[lvl]) if reference.shape[-1] == 4: outputs_coord = box_ops.box_xyxy_to_cxcywh(box_ops.delta2bbox(reference, tmp, max_shape)) else: raise NotImplementedError outputs_classes_one2one.append(outputs_class[:, 0 : self.num_queries_one2one]) outputs_classes_one2many.append(outputs_class[:, self.num_queries_one2one :]) outputs_coords_one2one.append(outputs_coord[:, 0 : self.num_queries_one2one]) outputs_coords_one2many.append(outputs_coord[:, self.num_queries_one2one :]) outputs_coords_old_one2one.append(reference[:, : self.num_queries_one2one]) outputs_coords_old_one2many.append(reference[:, self.num_queries_one2one :]) outputs_deltas_one2one.append(tmp[:, : self.num_queries_one2one]) outputs_deltas_one2many.append(tmp[:, self.num_queries_one2one :]) outputs_classes_one2one = torch.stack(outputs_classes_one2one) outputs_coords_one2one = torch.stack(outputs_coords_one2one) outputs_classes_one2many = torch.stack(outputs_classes_one2many) outputs_coords_one2many = torch.stack(outputs_coords_one2many) out = { "pred_logits": outputs_classes_one2one[-1], "pred_boxes": outputs_coords_one2one[-1], "pred_logits_one2many": outputs_classes_one2many[-1], "pred_boxes_one2many": outputs_coords_one2many[-1], "pred_boxes_old": outputs_coords_old_one2one[-1], "pred_deltas": outputs_deltas_one2one[-1], "pred_boxes_old_one2many": outputs_coords_old_one2many[-1], "pred_deltas_one2many": outputs_deltas_one2many[-1], } if self.aux_loss: out["aux_outputs"] = self._set_aux_loss( outputs_classes_one2one, outputs_coords_one2one, outputs_coords_old_one2one, outputs_deltas_one2one ) out["aux_outputs_one2many"] = self._set_aux_loss( outputs_classes_one2many, outputs_coords_one2many, outputs_coords_old_one2many, outputs_deltas_one2many ) if self.two_stage: out["enc_outputs"] = { "pred_logits": enc_outputs_class, "pred_boxes": enc_outputs_coord_unact, "pred_boxes_old": output_proposals, "pred_deltas": enc_outputs_delta, } return out @torch.jit.unused def _set_aux_loss(self, outputs_class, outputs_coord, outputs_coord_old, outputs_deltas): # this is a workaround to make torchscript happy, as torchscript # doesn't support dictionary with non-homogeneous values, such # as a dict having both a Tensor and a list. return [ { "pred_logits": a, "pred_boxes": b, "pred_boxes_old": c, "pred_deltas": d, } for a, b, c, d in zip(outputs_class[:-1], outputs_coord[:-1], outputs_coord_old[:-1], outputs_deltas[:-1]) ] class PostProcess(nn.Module): """This module converts the model's output into the format expected by the coco api""" def __init__(self, topk=100, reparam=False): super().__init__() self.topk = topk self.reparam = reparam @torch.no_grad() def forward(self, outputs, target_sizes, original_target_sizes=None): """Perform the computation Parameters: outputs: raw outputs of the model target_sizes: tensor of dimension [batch_size x 2] containing the size of each images of the batch For evaluation, this must be the original image size (before any data augmentation) For visualization, this should be the image size after data augment, but before padding """ out_logits, out_bbox = outputs["pred_logits"], outputs["pred_boxes"] assert len(out_logits) == len(target_sizes) assert target_sizes.shape[1] == 2 assert not self.reparam or original_target_sizes.shape[1] == 2 prob = out_logits.sigmoid() topk_values, topk_indexes = torch.topk(prob.view(out_logits.shape[0], -1), self.topk, dim=1) scores = topk_values topk_boxes = topk_indexes // out_logits.shape[2] labels = topk_indexes % out_logits.shape[2] boxes = box_ops.box_cxcywh_to_xyxy(out_bbox) boxes = torch.gather(boxes, 1, topk_boxes.unsqueeze(-1).repeat(1, 1, 4)) # and from relative [0, 1] to absolute [0, height] coordinates img_h, img_w = target_sizes.unbind(1) if self.reparam: img_h, img_w = img_h[:, None, None], img_w[:, None, None] # [BS, 1, 1] boxes[..., 0::2].clamp_(min=torch.zeros_like(img_w), max=img_w) boxes[..., 1::2].clamp_(min=torch.zeros_like(img_h), max=img_h) scale_h, scale_w = (original_target_sizes / target_sizes).unbind(1) scale_fct = torch.stack([scale_w, scale_h, scale_w, scale_h], dim=1) else: scale_fct = torch.stack([img_w, img_h, img_w, img_h], dim=1) boxes = boxes * scale_fct[:, None, :] results = [{"scores": s, "labels": l, "boxes": b} for s, l, b in zip(scores, labels, boxes)] return results class MLP(nn.Module): """Very simple multi-layer perceptron (also called FFN)""" def __init__(self, input_dim, hidden_dim, output_dim, num_layers): super().__init__() self.num_layers = num_layers h = [hidden_dim] * (num_layers - 1) self.layers = nn.ModuleList(nn.Linear(n, k) for n, k in zip([input_dim] + h, h + [output_dim])) def forward(self, x): for i, layer in enumerate(self.layers): x = F.relu(layer(x)) if i < self.num_layers - 1 else layer(x) return x def build_model(backbone_model, args): backbone = build_backbone(backbone_model, args) transformer = build_transformer(args) model_class = PlainDETR if (not args.reparam) else PlainDETRReParam return model_class( backbone, transformer, num_classes=args.num_classes, num_feature_levels=args.num_feature_levels, aux_loss=args.aux_loss, with_box_refine=args.with_box_refine, two_stage=args.two_stage, num_queries_one2one=args.num_queries_one2one, num_queries_one2many=args.num_queries_one2many, mixed_selection=args.mixed_selection, )