RT-DETR模型源码解析

# Ultralytics YOLO , AGPL-3.0 license

import torch
import inspect
import sys
from pathlib import Path
from typing import Union

from ultralytics.cfg import TASK2DATA, get_cfg, get_save_dir
from ultralytics.hub.utils import HUB_WEB_ROOT
from ultralytics.nn.tasks import attempt_load_one_weight, guess_model_task, nn, yaml_model_load
from ultralytics.utils import ASSETS, DEFAULT_CFG_DICT, LOGGER, RANK, callbacks, checks, emojis, yaml_load
from ultralytics.utils.downloads import GITHUB_ASSETS_STEMS


class Model(nn.Module):
    """
    A base class to unify APIs for all models.

    Args:
        model (str, Path): Path to the model file to load or create.
        task (Any, optional): Task type for the YOLO model. Defaults to None.
    这段代码定义了一个基类，旨在统一所有模型的API接口。
    这个基类提供了一系列属性和方法，使得不同的模型可以通过这个统一的接口进行操作。下面是对这个基类及其方法和属性的详细解释：
    model (str, Path): 模型文件的路径，用于加载或创建模型。
    task (Any, optional): YOLO模型的任务类型。默认为None。

        属性（Attributes）
        predictor (Any): 预测器对象。
        model (Any): 模型对象。
        trainer (Any): 训练器对象。
        task (str): 模型任务的类型。
        ckpt (Any): 如果模型是从*.pt文件加载的，那么这是检查点对象。
        cfg (str): 如果模型是从*.yaml文件加载的，那么这是模型配置。
        ckpt_path (str): 检查点文件的路径。
        overrides (dict): 训练器对象的覆盖设置。
        metrics (Any): 度量数据。

        方法（Methods）
        __call__(source=None, stream=False, **kwargs):
        是predict方法的别名。
        _new(cfg:str, verbose:bool=True) -> None:
        初始化一个新模型，并从模型定义中推断任务类型。
        _load(weights:str, task:str='') -> None:
        初始化一个新模型，并从模型头部推断任务类型。
        _check_is_pytorch_model() -> None:
        如果模型不是PyTorch模型，则抛出TypeError。
        reset() -> None:
        重置模型模块。
        info(verbose:bool=False) -> None:
        记录模型信息。
        fuse() -> None:
        融合模型以加快推理速度。
        predict(source=None, stream=False, **kwargs) -> List[ultralytics.engine.results.Results]:
        使用YOLO模型进行预测。
        返回值
        返回一个列表，包含ultralytics.engine.results.Results对象，表示预测结果。
    """

    def __init__(self, model: Union[str, Path] = 'yolov8n.pt', task=None) -> None:

        """
        model: Union[str, Path] 是Python类型注解的一种用法，用于指定变量或函数参数的类型。
        在这个上下文中，它出现在类的构造函数（__init__ 方法）的参数列表中，
        用于指明 model 参数可以接受两种类型：str（字符串）或 Path（来自 pathlib 模块的路径对象）。
        Path：pathlib 模块中的一个类，用于表示文件系统路径。
        Initializes the YOLO model.

        Args:
            model (Union[str, Path], optional): Path or name of the model to load or create. Defaults to 'yolov8n.pt'.
            task (Any, optional): Task type for the YOLO model. Defaults to None.
        """
        super().__init__()
        self.callbacks = callbacks.get_default_callbacks()#这行代码初始化了一个名为 callbacks 的属性，
        # 它通过调用 callbacks.get_default_callbacks() 方法来获取默认的回调函数列表。这些回调函数可能在训练或验证过程中被调用。
        self.predictor = None  # reuse predictor 注释表明这个属性用于重用预测器对象
        self.model = None  # model object   注释表明这个属性将用于存储模型对象
        self.trainer = None  # trainer object   注释表明这个属性将用于存储训练器对象
        self.ckpt = None  # if loaded from *.pt     注释表明这个属性将用于存储从 .pt 文件加载的检查点。
        self.cfg = None  # if loaded from *.yaml    注释表明这个属性将用于存储从 .yaml 文件加载的配置。
        self.ckpt_path = None           #这个属性可能用于存储检查点的路径。
        self.overrides = {}  # overrides for trainer object  注释表明这个字典用于存储对训练器对象的覆盖设置。
        #存储对训练器对象的覆盖设置意味着在创建训练器对象时，你可以通过传递一个包含特定键值对的字典来覆盖训练器的默认设置。
        # 这些键值对指定了你想要修改的训练器参数和它们的新值。通过这种方式，你可以自定义训练器的行为，以适应你的特定需求。
        # 例如，你可能想要改变学习率、批量大小、训练轮数等参数。这些覆盖设置通常在训练器的初始化过程中应用，并影响训练器的后续行为。
        self.metrics = None  # validation/training metrics  用于存储验证和训练的度量数据。
        #在机器学习和深度学习领域，“度量数据”（metrics）是衡量模型性能的关键指标。这些指标能够量化模型在训练集和验证集上的表现，
        # 例如准确率、召回率、F1分数、损失值等。通过观察这些度量数据，我们可以评估模型的优劣，并据此调整模型参数或训练策略。
        self.session = None  # HUB session  属性将用于存储 Ultralytics HUB 的会话对象。
        #“Ultralytics HUB的会话对象”是指在使用Ultralytics HUB平台时，系统为用户分配的一个唯一会话标识。
        # 这个会话对象包含了用户在平台上的所有操作信息，如模型训练、数据上传、结果查看等。
        # 通过这个会话对象，平台能够追踪和管理用户的活动，确保用户能够顺畅地使用平台提供的各项功能。
        self.task = task  # task type 注释表明这个属性用于存储任务类型
        #任务类型”则是指机器学习或深度学习中的具体任务，如图像分类、目标检测、语义分割等。
        #每种任务都有其独特的数据集、模型架构和性能评估指标。在训练模型时，我们首先需要明确任务类型，以便选择适合的模型和数据集进行训练。
        model = str(model).strip()  # strip spaces  这行代码将传入的 model 参数转换为字符串（如果它还不是字符串的话），
        # 并去除字符串两端的空格。处理后的字符串被重新赋值给局部变量 model，
        # 注意这里并没有使用 self.model，所以这只是对局部变量 model 的操作，而不是对实例属性的操作。
        # 如果想要更新实例属性，应该使用 self.model = str(model).

        # Check if Ultralytics HUB model from https://hub.ultralytics.com
        if self.is_hub_model(model):
            from ultralytics.hub.session import HUBTrainingSession
            self.session = HUBTrainingSession(model)
            model = self.session.model_file
            #使用self.is_hub_model(model)方法检查传入的model是否是一个Ultralytics HUB模型。
            #如果是，从ultralytics.hub.session导入HUBTrainingSession类，并创建一个HUBTrainingSession实例，将其赋值给self.session。
            #通过self.session.model_file获取HUB模型的文件路径，并将其赋值给model变量，以便后续使用。

        # Check if Triton Server model
        elif self.is_triton_model(model):
            self.model = model
            self.task = task
            return

        # Load or create new YOLO model
        suffix = Path(model).suffix #这行代码使用pathlib.Path对象来获取model字符串的后缀。
        # 例如，如果model是"yolov8n.pt"，那么suffix将是".pt"。
        #suffix方法的作用是提取并返回self.name的最后一个后缀（如果存在且不是整个名称）。
        # 例如，如果self.name是"example.txt"，那么suffix方法将返回".txt"；如果self.name是"example"，那么将返回空字符串
        if not suffix and Path(model).stem in GITHUB_ASSETS_STEMS:
            model, suffix = Path(model).with_suffix('.pt'), '.pt'  # add suffix, i.e. yolov8n -> yolov8n.pt
            #该函数用于更改Path对象的文件后缀。如果Path对象没有后缀，则添加给定的后缀。
            # 如果给定的后缀为空字符串，则移除Path对象的后缀。函数参数suffix为要更改的后缀。
            # 函数内部会进行一些有效性检查，如检查后缀中是否包含路径分隔符，后缀是否以'.'开头等。然后根据是否已有后缀进行相应的处理，
            # 最后返回一个新的Path对象。
        if suffix in ('.yaml', '.yml'):
            self._new(model, task)
        else:
            self._load(model, task)
        #这段代码的目的是根据model字符串的后缀和/或其与GIT