mot

docs/module_usage/tutorials/cv_modules/multi_object_tracking.md

@@ -0,0 +1,190 @@
+简体中文 | [English](multi_object_tracking_en.md)
+
+# 多目标跟踪模块使用教程
+
+## 一、概述
+
+多目标跟踪任务是一项重要的研究内容，它涉及在视频序列中自动识别和跟踪多个感兴趣的目标。多目标跟踪要求在视频序列中同时跟踪多个目标对象，并获取它们的运动轨迹，同时保持目标的身份一致性。这些目标可以是行人、车辆、动物或其他任何类别的物体。视频监控、自动驾驶、无人机监测等领域具有重要意义。
+
+## 二、支持模型列表
+
+<details>
+   <summary> 👉模型列表详情</summary>
+
+|模型|数据集|MOTA|IDF1|
+|-|-|-|-|
+|FairMOT-DLA-34|MOT-16 Training Set|83.2|83.1|
+|DeepSORT_PP-YOLOE_ResNet|MOT-17 half Val Set|56.7|64.6|
+|ByteTrack_PP-YOLOE_L|MOT-17 half train Set|50.4|59.7|
+
+**以上模型精度指标测量自 MOT-16和MOT-17 数据集。**
+
+</details>
+
+## 三、快速集成
+> ❗ 在快速集成前，请先安装 PaddleX 的 wheel 包，详细请参考 [PaddleX本地安装教程](../../../installation/installation.md)
+
+完成wheel包的安装后，几行代码即可完成多目标跟踪模块的推理，可以任意切换该模块下的模型，您也可以将多目标跟踪的模块中的模型推理集成到您的项目中。
+运行以下代码前，请您下载[示例图片](待填充)到本地。
+```bash
+from paddlex.inference import create_model 
+
+model_name = "ByteTrack_PP-YOLOE_L"
+
+model = create_model(model_name)
+output = model.predict("mot.png", batch_size=1)
+
+for res in output:
+    res.print(json_format=False)
+    res.save_to_img("./output/")
+    res.save_to_json("./output/res.json")
+```
+关于更多 PaddleX 的单模型推理的 API 的使用方法，可以参考[PaddleX单模型Python脚本使用说明](../../instructions/model_python_API.md)。
+
+## 四、二次开发
+如果你追求更高精度的现有模型，可以使用PaddleX的二次开发能力，开发更好的多目标跟踪模型。在使用PaddleX开发多目标跟踪模型之前，请务必安装PaddleDetection插件，安装过程可以参考[PaddleX本地安装教程](../../../installation/installation.md)。
+
+### 4.1 数据准备
+在进行模型训练前，需要准备相应任务模块的数据集。PaddleX 针对每一个模块提供了数据校验功能，**只有通过数据校验的数据才可以进行模型训练**。此外，PaddleX为每一个模块都提供了Demo数据集，您可以基于官方提供的 Demo 数据完成后续的开发。可以参考[PaddleX多目标跟踪任务模块数据标注教程](待填充)。
+
+#### 4.1.1 Demo 数据下载
+您可以参考下面的命令将 Demo 数据集下载到指定文件夹：
+
+```bash
+cd /path/to/paddlex
+wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/mot_examples.tar -P ./dataset
+tar -xf ./dataset/mot_examples.tar -C ./dataset/
+```
+#### 4.1.2 数据校验
+一行命令即可完成数据校验：
+
+```bash
+python main.py -c paddlex/configs/multi_object_tracking/ByteTrack_PP-YOLOE_L.yaml \
+    -o Global.mode=check_dataset \
+    -o Global.dataset_dir=./dataset/mot_examples
+```
+执行上述命令后，PaddleX 会对数据集进行校验，并统计数据集的基本信息，命令运行成功后会在log中打印出`Check dataset passed !`信息。校验结果文件保存在`./output/check_dataset_result.json`，同时相关产出会保存在当前目录的`./output/check_dataset`目录下，产出目录中包括可视化的示例样本图片和样本分布直方图。
+
+<details>
+  <summary>👉 <b>校验结果详情（点击展开）</b></summary>
+
+
+校验结果文件具体内容为：
+
+```bash
+{
+  "done_flag": true,
+  "check_pass": true,
+  "attributes": {
+    "num_classes": 1,
+    "train_samples": 5316,
+    "train_sample_paths": [
+      "check_dataset/demo_img/train/0.jpg",
+      "check_dataset/demo_img/train/1.jpg",
+      "check_dataset/demo_img/train/2.jpg",
+    ],
+    "val_samples": 5316,
+    "val_sample_paths": [
+      "check_dataset/demo_img/val/0.jpg",
+      "check_dataset/demo_img/val/1.jpg",
+      "check_dataset/demo_img/val/2.jpg",
+    ]
+  },
+  "analysis": null,
+  "dataset_path": "dataset/mot_datasetss",
+  "show_type": "image",
+  "dataset_type": "COCODetDataset"
+}
+```
+上述校验结果中，`check_pass` 为 `True` 表示数据集格式符合要求，其他部分指标的说明如下：
+
+* `attributes.train_samples`：该数据集训练集样本数量为 5316；
+* `attributes.val_samples`：该数据集验证集样本数量为 5316；
+* `attributes.train_sample_paths`：该数据集训练集样本可视化图片相对路径列表；
+* `attributes.val_sample_paths`：该数据集验证集样本可视化图片相对路径列表；
+</details>
+
+### 4.2 模型训练
+一条命令即可完成模型的训练，以此处ByteTrack_PP-YOLOE_L的训练为例：
+
+```bash
+python main.py -c paddlex/configs/multi_object_tracking/ByteTrack_PP-YOLOE_L.yaml \
+    -o Global.mode=train \
+    -o Global.dataset_dir=./dataset/mot_examples
+```
+需要如下几步：
+
+* 指定模型的`.yaml` 配置文件路径（此处为`ByteTrack_PP-YOLOE_L.yaml`）
+* 指定模式为模型训练：`-o Global.mode=train`
+* 指定训练数据集路径：`-o Global.dataset_dir`
+其他相关参数均可通过修改`.yaml`配置文件中的`Global`和`Train`下的字段来进行设置，也可以通过在命令行中追加参数来进行调整。如指定前 2 卡 gpu 训练：`-o Global.device=gpu:0,1`；设置训练轮次数为 10：`-o Train.epochs_iters=10`。更多可修改的参数及其详细解释，可以查阅查阅模型对应任务模块的配置文件说明[PaddleX通用模型配置文件参数说明](../../instructions/config_parameters_common.md)。
+
+<details>
+  <summary>👉 <b>更多说明（点击展开）</b></summary>
+
+
+* 模型训练过程中，PaddleX 会自动保存模型权重文件，默认为`output`，如需指定保存路径，可通过配置文件中 `-o Global.output` 字段进行设置。
+* PaddleX 对您屏蔽了动态图权重和静态图权重的概念。在模型训练的过程中，会同时产出动态图和静态图的权重，在模型推理时，默认选择静态图权重推理。
+* 训练其他模型时，需要的指定相应的配置文件，模型和配置的文件的对应关系，可以查阅[PaddleX模型列表（CPU/GPU）](../../../support_list/models_list.md)。
+在完成模型训练后，所有产出保存在指定的输出目录（默认为`./output/`）下，通常有以下产出：
+
+* `train_result.json`：训练结果记录文件，记录了训练任务是否正常完成，以及产出的权重指标、相关文件路径等；
+* `train.log`：训练日志文件，记录了训练过程中的模型指标变化、loss 变化等；
+* `config.yaml`：训练配置文件，记录了本次训练的超参数的配置；
+* `.pdparams`、`.pdema`、`.pdopt.pdstate`、`.pdiparams`、`.pdmodel`：模型权重相关文件，包括网络参数、优化器、EMA、静态图网络参数、静态图网络结构等；
+</details>
+
+### **4.3 模型评估**
+在完成模型训练后，可以对指定的模型权重文件在验证集上进行评估，验证模型精度。使用 PaddleX 进行模型评估，一条命令即可完成模型的评估：
+
+```bash
+python main.py -c paddlex/configs/multi_object_tracking/ByteTrack_PP-YOLOE_L.yaml \
+    -o Global.mode=evaluate \
+    -o Global.dataset_dir=./dataset/mot_examples
+```
+与模型训练类似，需要如下几步：
+
+* 指定模型的`.yaml` 配置文件路径（此处为`ByteTrack_PP-YOLOE_L.yaml`）
+* 指定模式为模型评估：`-o Global.mode=evaluate`
+* 指定验证数据集路径：`-o Global.dataset_dir`
+其他相关参数均可通过修改`.yaml`配置文件中的`Global`和`Evaluate`下的字段来进行设置，详细请参考[PaddleX通用模型配置文件参数说明](../../instructions/config_parameters_common.md)。
+
+<details>
+  <summary>👉 <b>更多说明（点击展开）</b></summary>
+
+
+在模型评估时，需要指定模型权重文件路径，每个配置文件中都内置了默认的权重保存路径，如需要改变，只需要通过追加命令行参数的形式进行设置即可，如`-o Evaluate.weight_path=./output/best_model/model.pdparams`。
+
+在完成模型评估后，会产出`evaluate_result.json，`记录评估的结果，具体来说，记录了评估任务是否正常完成，以及模型的评估指标，包含 MOTA；
+
+</details>
+
+### **4.4 模型推理**
+在完成模型的训练和评估后，即可使用训练好的模型权重进行推理预测或者进行Python集成。
+
+#### 4.4.1 模型推理
+* 通过命令行的方式进行推理预测，只需如下一条命令，运行以下代码前，请您下载[示例图片](待填充)到本地。
+```bash
+python main.py -c paddlex/configs/multi_object_tracking/ByteTrack_PP-YOLOE_L.yaml \
+    -o Global.mode=predict \
+    -o Predict.model_dir="./output/best_model/inference" \
+    -o Predict.input="mot.png"
+```
+与模型训练和评估类似，需要如下几步：
+
+* 指定模型的`.yaml` 配置文件路径（此处为`ByteTrack_PP-YOLOE_L.yaml`）
+* 指定模式为模型推理预测：`-o Global.mode=predict`
+* 指定模型权重路径：`-o Predict.model_dir="./output/best_model/inference"`
+* 指定输入数据路径：`-o Predict.input="..."`
+其他相关参数均可通过修改`.yaml`配置文件中的`Global`和`Predict`下的字段来进行设置，详细请参考[PaddleX通用模型配置文件参数说明](../../instructions/config_parameters_common.md)。
+
+#### 4.4.2 模型集成
+模型可以直接集成到 PaddleX 产线中，也可以直接集成到您自己的项目中。
+
+1.**产线集成**
+
+多目标跟踪模块可以集成的PaddleX产线有[多目标跟踪产线](待填充)，只需要替换模型路径即可完成相关产线的多目标跟踪模块的模型更新。在产线集成中，你可以使用高性能部署和服务化部署来部署你得到的模型。
+
+2.**模块集成**
+
+您产出的权重可以直接集成到多目标跟踪模块中，可以参考[快速集成](#三快速集成)的 Python 示例代码，只需要将模型替换为你训练的到的模型路径即可。

paddlex/configs/multi_object_tracking/ByteTrack_PP-YOLOE_L.yaml

@@ -0,0 +1,42 @@
+Global:
+  model: ByteTrack_PP-YOLOE_L
+  mode: check_dataset # check_dataset/train/evaluate/predict
+  dataset_dir: "/paddle/dataset/paddlex/det/det_coco_examples"
+  device: gpu:0,1,2,3
+  output: "output"
+
+CheckDataset:
+  convert:
+    enable: False
+    src_dataset_type: null
+  split:
+    enable: False
+    train_percent: null
+    val_percent: null
+
+Train:
+  num_classes: 1
+  epochs_iters: 50
+  batch_size: #2
+  learning_rate: #0.0001
+  pretrain_weight_path: null
+  warmup_steps: #100
+  resume_path: null
+  log_interval: 10
+  eval_interval: 1
+
+Evaluate:
+  weight_path: "output/best_model/best_model.pdparams"
+  log_interval: 10
+
+Predict:
+  batch_size: 1
+  model_dir: "output/best_model/inference"
+  input: "https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png"
+  kernel_option:
+    run_mode: paddle
+
+
+
+Export:
+  weight_path: # https://paddledet.bj.bcebos.com/models/detr_r50_1x_coco.pdparams

paddlex/configs/multi_object_tracking/DeepSORT_PP-YOLOE_ResNet.yaml

@@ -0,0 +1,42 @@
+Global:
+  model: DeepSORT_PP-YOLOE_ResNet
+  mode: check_dataset # check_dataset/train/evaluate/predict
+  dataset_dir: "/paddle/dataset/paddlex/det/det_coco_examples"
+  device: gpu:0,1,2,3
+  output: "output"
+
+CheckDataset:
+  convert:
+    enable: False
+    src_dataset_type: null
+  split:
+    enable: False
+    train_percent: null
+    val_percent: null
+
+Train:
+  num_classes: 1
+  epochs_iters: 50
+  batch_size: 2
+  learning_rate: #0.0001
+  pretrain_weight_path: null
+  warmup_steps: #100
+  resume_path: null
+  log_interval: 10
+  eval_interval: 1
+
+Evaluate:
+  weight_path: "output/best_model/best_model.pdparams"
+  log_interval: 10
+
+Predict:
+  batch_size: 1
+  model_dir: "output/best_model/inference"
+  input: "https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png"
+  kernel_option:
+    run_mode: paddle
+
+
+
+Export:
+  weight_path: # https://paddledet.bj.bcebos.com/models/detr_r50_1x_coco.pdparams

paddlex/configs/multi_object_tracking/FairMOT-DLA-34.yaml

@@ -0,0 +1,42 @@
+Global:
+  model: FairMOT-DLA-34
+  mode: check_dataset # check_dataset/train/evaluate/predict
+  dataset_dir: "/paddle/dataset/paddlex/det/det_coco_examples"
+  device: gpu:0,1,2,3
+  output: "output"
+
+CheckDataset:
+  convert:
+    enable: False
+    src_dataset_type: null
+  split:
+    enable: False
+    train_percent: null
+    val_percent: null
+
+Train:
+  num_classes: 1
+  epochs_iters: # 50
+  batch_size: # 2
+  learning_rate: # 0.0001
+  pretrain_weight_path: null
+  warmup_steps: #100
+  resume_path: null
+  log_interval: 10
+  eval_interval: 1
+
+Evaluate:
+  weight_path: "output/best_model/best_model.pdparams"
+  log_interval: 10
+
+Predict:
+  batch_size: 1
+  model_dir: "output/best_model/inference"
+  input: "https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png"
+  kernel_option:
+    run_mode: paddle
+
+
+
+Export:
+  weight_path: # https://paddledet.bj.bcebos.com/models/detr_r50_1x_coco.pdparams

paddlex/modules/__init__.py

@@ -95,4 +95,11 @@
     TSCLSExportor,
 )
 
+from .multi_object_tracking import (
+    MOTDatasetChecker,
+    MOTTrainer,
+    MOTEvaluator,
+    MOTExportor,
+)
+
 from .ts_forecast import TSFCDatasetChecker, TSFCTrainer, TSFCEvaluator

paddlex/modules/multi_object_tracking/__init__.py

@@ -0,0 +1,18 @@
+# copyright (c) 2024 PaddlePaddle Authors. All Rights Reserve.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .trainer import MOTTrainer
+from .dataset_checker import MOTDatasetChecker
+from .evaluator import MOTEvaluator
+from .exportor import MOTExportor