# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license from __future__ import annotations import subprocess import sys import types from pathlib import Path from shutil import which import numpy as np import torch from ultralytics.nn.modules import Detect, Pose, Segment from ultralytics.utils import LOGGER, WINDOWS from ultralytics.utils.patches import onnx_export_patch from ultralytics.utils.tal import make_anchors from ultralytics.utils.torch_utils import copy_attr # Configuration for Model Compression Toolkit (MCT) quantization MCT_CONFIG = { "YOLO11": { "detect": { "layer_names": ["sub", "mul_2", "add_14", "cat_19"], "weights_memory": 2585350.2439, "n_layers": {238, 239}, }, "pose": { "layer_names": ["sub", "mul_2", "add_14", "cat_21", "cat_22", "mul_4", "add_15"], "weights_memory": 2437771.67, "n_layers": {257, 258}, }, "classify": {"layer_names": [], "weights_memory": np.inf, "n_layers": {112}}, "segment": { "layer_names": ["sub", "mul_2", "add_14", "cat_21"], "weights_memory": 2466604.8, "n_layers": {265, 266}, }, }, "YOLOv8": { "detect": { "layer_names": ["sub", "mul", "add_6", "cat_15"], "weights_memory": 2550540.8, "n_layers": {168, 169}, }, "pose": { "layer_names": ["add_7", "mul_2", "cat_17", "mul", "sub", "add_6", "cat_18"], "weights_memory": 2482451.85, "n_layers": {187, 188}, }, "classify": {"layer_names": [], "weights_memory": np.inf, "n_layers": {73}}, "segment": { "layer_names": ["sub", "mul", "add_6", "cat_17"], "weights_memory": 2580060.0, "n_layers": {195, 196}, }, }, } class FXModel(torch.nn.Module): """A custom model class for torch.fx compatibility. This class extends `torch.nn.Module` and is designed to ensure compatibility with torch.fx for tracing and graph manipulation. It copies attributes from an existing model and explicitly sets the model attribute to ensure proper copying. Attributes: model (nn.Module): The original model's layers. imgsz (tuple[int, int]): The input image size (height, width). """ def __init__(self, model, imgsz=(640, 640)): """Initialize the FXModel. Args: model (nn.Module): The original model to wrap for torch.fx compatibility. imgsz (tuple[int, int]): The input image size (height, width). Default is (640, 640). """ super().__init__() copy_attr(self, model) # Explicitly set `model` since `copy_attr` somehow does not copy it. self.model = model.model self.imgsz = imgsz def forward(self, x): """Forward pass through the model. This method performs the forward pass through the model, handling the dependencies between layers and saving intermediate outputs. Args: x (torch.Tensor): The input tensor to the model. Returns: (torch.Tensor): The output tensor from the model. """ y = [] # outputs for m in self.model: if m.f != -1: # if not from previous layer # from earlier layers x = y[m.f] if isinstance(m.f, int) else [x if j == -1 else y[j] for j in m.f] if isinstance(m, Detect): m._inference = types.MethodType(_inference, m) # bind method to Detect m.anchors, m.strides = ( x.transpose(0, 1) for x in make_anchors( torch.cat([s / m.stride.unsqueeze(-1) for s in self.imgsz], dim=1), m.stride, 0.5 ) ) if type(m) is Pose: m.forward = types.MethodType(pose_forward, m) # bind method to Pose if type(m) is Segment: m.forward = types.MethodType(segment_forward, m) # bind method to Segment x = m(x) # run y.append(x) # save output return x def _inference(self, x: dict[str, torch.Tensor]) -> tuple[torch.Tensor, torch.Tensor]: """Decode boxes and cls scores for imx object detection.""" dbox = self.decode_bboxes(self.dfl(x["boxes"]), self.anchors.unsqueeze(0)) * self.strides return dbox.transpose(1, 2), x["scores"].sigmoid().permute(0, 2, 1) def pose_forward(self, x: list[torch.Tensor]) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor]: """Forward pass for imx pose estimation, including keypoint decoding.""" bs = x[0].shape[0] # batch size nk_out = getattr(self, "nk_output", self.nk) kpt = torch.cat([self.cv4[i](x[i]).view(bs, nk_out, -1) for i in range(self.nl)], -1) # If using Pose26 with 5 dims, convert to 3 dims for export if hasattr(self, "nk_output") and self.nk_output != self.nk: spatial = kpt.shape[-1] kpt = kpt.view(bs, self.kpt_shape[0], self.kpt_shape[1] + 2, spatial) kpt = kpt[:, :, :-2, :] # Remove sigma_x, sigma_y kpt = kpt.view(bs, self.nk, spatial) x = Detect.forward(self, x) pred_kpt = self.kpts_decode(kpt) return *x, pred_kpt.permute(0, 2, 1) def segment_forward(self, x: list[torch.Tensor]) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor, torch.Tensor]: """Forward pass for imx segmentation.""" p = self.proto(x[0]) # mask protos bs = p.shape[0] # batch size mc = torch.cat([self.cv4[i](x[i]).view(bs, self.nm, -1) for i in range(self.nl)], 2) # mask coefficients x = Detect.forward(self, x) return *x, mc.transpose(1, 2), p class NMSWrapper(torch.nn.Module): """Wrap PyTorch Module with multiclass_nms layer from edge-mdt-cl.""" def __init__( self, model: torch.nn.Module, score_threshold: float = 0.001, iou_threshold: float = 0.7, max_detections: int = 300, task: str = "detect", ): """Initialize NMSWrapper with PyTorch Module and NMS parameters. Args: model (torch.nn.Module): Model instance. score_threshold (float): Score threshold for non-maximum suppression. iou_threshold (float): Intersection over union threshold for non-maximum suppression. max_detections (int): The number of detections to return. task (str): Task type, one of 'detect', 'pose', or 'segment'. """ super().__init__() self.model = model self.score_threshold = score_threshold self.iou_threshold = iou_threshold self.max_detections = max_detections self.task = task def forward(self, images): """Forward pass with model inference and NMS post-processing.""" from edgemdt_cl.pytorch.nms.nms_with_indices import multiclass_nms_with_indices # model inference outputs = self.model(images) boxes, scores = outputs[0], outputs[1] nms_outputs = multiclass_nms_with_indices( boxes=boxes, scores=scores, score_threshold=self.score_threshold, iou_threshold=self.iou_threshold, max_detections=self.max_detections, ) if self.task == "pose": kpts = outputs[2] # (bs, max_detections, kpts 17*3) out_kpts = torch.gather(kpts, 1, nms_outputs.indices.unsqueeze(-1).expand(-1, -1, kpts.size(-1))) return nms_outputs.boxes, nms_outputs.scores, nms_outputs.labels, out_kpts if self.task == "segment": mc, proto = outputs[2], outputs[3] out_mc = torch.gather(mc, 1, nms_outputs.indices.unsqueeze(-1).expand(-1, -1, mc.size(-1))) return nms_outputs.boxes, nms_outputs.scores, nms_outputs.labels, out_mc, proto return nms_outputs.boxes, nms_outputs.scores, nms_outputs.labels, nms_outputs.n_valid def torch2imx( model: torch.nn.Module, file: Path | str, conf: float, iou: float, max_det: int, metadata: dict | None = None, gptq: bool = False, dataset=None, prefix: str = "", ): """Export YOLO model to IMX format for deployment on Sony IMX500 devices. This function quantizes a YOLO model using Model Compression Toolkit (MCT) and exports it to IMX format compatible with Sony IMX500 edge devices. It supports both YOLOv8n and YOLO11n models for detection, segmentation, pose estimation, and classification tasks. Args: model (torch.nn.Module): The YOLO model to export. Must be YOLOv8n or YOLO11n. file (Path | str): Output file path for the exported model. conf (float): Confidence threshold for NMS post-processing. iou (float): IoU threshold for NMS post-processing. max_det (int): Maximum number of detections to return. metadata (dict | None, optional): Metadata to embed in the ONNX model. Defaults to None. gptq (bool, optional): Whether to use Gradient-Based Post Training Quantization. If False, uses standard Post Training Quantization. Defaults to False. dataset (optional): Representative dataset for quantization calibration. Defaults to None. prefix (str, optional): Logging prefix string. Defaults to "". Returns: (Path): Path to the exported IMX model directory. Raises: ValueError: If the model is not a supported YOLOv8n or YOLO11n variant. Examples: >>> from ultralytics import YOLO >>> model = YOLO("yolo11n.pt") >>> path = torch2imx(model, "model.imx", conf=0.25, iou=0.7, max_det=300) Notes: - Requires model_compression_toolkit, onnx, edgemdt_tpc, and edge-mdt-cl packages - Only supports YOLOv8n and YOLO11n models (detection, segmentation, pose, and classification tasks) - Output includes quantized ONNX model, IMX binary, and labels.txt file """ import model_compression_toolkit as mct import onnx from edgemdt_tpc import get_target_platform_capabilities LOGGER.info(f"\n{prefix} starting export with model_compression_toolkit {mct.__version__}...") def representative_dataset_gen(dataloader=dataset): for batch in dataloader: img = batch["img"] img = img / 255.0 yield [img] # NOTE: need tpc_version to be "4.0" for IMX500 Pose estimation models tpc = get_target_platform_capabilities(tpc_version="4.0", device_type="imx500") bit_cfg = mct.core.BitWidthConfig() mct_config = MCT_CONFIG["YOLO11" if "C2PSA" in model.__str__() else "YOLOv8"][model.task] # Check if the model has the expected number of layers if len(list(model.modules())) not in mct_config["n_layers"]: raise ValueError("IMX export only supported for YOLOv8n and YOLO11n models.") for layer_name in mct_config["layer_names"]: bit_cfg.set_manual_activation_bit_width([mct.core.common.network_editors.NodeNameFilter(layer_name)], 16) config = mct.core.CoreConfig( mixed_precision_config=mct.core.MixedPrecisionQuantizationConfig(num_of_images=10), quantization_config=mct.core.QuantizationConfig(concat_threshold_update=True), bit_width_config=bit_cfg, ) resource_utilization = mct.core.ResourceUtilization(weights_memory=mct_config["weights_memory"]) quant_model = ( mct.gptq.pytorch_gradient_post_training_quantization( # Perform Gradient-Based Post Training Quantization model=model, representative_data_gen=representative_dataset_gen, target_resource_utilization=resource_utilization, gptq_config=mct.gptq.get_pytorch_gptq_config( n_epochs=1000, use_hessian_based_weights=False, use_hessian_sample_attention=False ), core_config=config, target_platform_capabilities=tpc, )[0] if gptq else mct.ptq.pytorch_post_training_quantization( # Perform post training quantization in_module=model, representative_data_gen=representative_dataset_gen, target_resource_utilization=resource_utilization, core_config=config, target_platform_capabilities=tpc, )[0] ) if model.task != "classify": quant_model = NMSWrapper( model=quant_model, score_threshold=conf or 0.001, iou_threshold=iou, max_detections=max_det, task=model.task, ) f = Path(str(file).replace(file.suffix, "_imx_model")) f.mkdir(exist_ok=True) onnx_model = f / Path(str(file.name).replace(file.suffix, "_imx.onnx")) # js dir with onnx_export_patch(): mct.exporter.pytorch_export_model( model=quant_model, save_model_path=onnx_model, repr_dataset=representative_dataset_gen ) model_onnx = onnx.load(onnx_model) # load onnx model for k, v in metadata.items(): meta = model_onnx.metadata_props.add() meta.key, meta.value = k, str(v) onnx.save(model_onnx, onnx_model) # Find imxconv-pt binary - check venv bin directory first, then PATH bin_dir = Path(sys.executable).parent imxconv = bin_dir / ("imxconv-pt.exe" if WINDOWS else "imxconv-pt") if not imxconv.exists(): imxconv = which("imxconv-pt") # fallback to PATH if not imxconv: raise FileNotFoundError("imxconv-pt not found. Install with: pip install imx500-converter[pt]") subprocess.run( [str(imxconv), "-i", str(onnx_model), "-o", str(f), "--no-input-persistency", "--overwrite-output"], check=True, ) # Needed for imx models. with open(f / "labels.txt", "w", encoding="utf-8") as file: file.writelines([f"{name}\n" for _, name in model.names.items()]) return f