add README_CN

README.md

@@ -1,2 +1,196 @@
 # PyTorch_YOLO_Tutorial
 YOLO Tutorial
+
+English | [简体中文](https://github.com/yjh0410/PyTorch_YOLO_Tutorial/blob/main/README_CN.md)
+
+## Requirements
+- We recommend you to use Anaconda to create a conda environment:
+```Shell
+conda create -n yolo python=3.6
+```
+
+- Then, activate the environment:
+```Shell
+conda activate yolo
+```
+
+- Requirements:
+```Shell
+pip install -r requirements.txt 
+```
+
+My environment:
+- PyTorch = 1.9.1
+- Torchvision = 0.10.1
+
+At least, please make sure your torch is version 1.x.
+
+## Training Configuration
+|   Configuration         |                            |
+|-------------------------|----------------------------|
+| Per GPU Batch Size      | 16                         |
+| Init Lr                 | 0.01                       |
+| Warmup Scheduler        | Linear                     |
+| Lr Scheduler            | Linear                     |
+| Optimizer               | SGD                        |
+| Multi Scale Train       | True                       |
+
+
+## Experiments
+### COCO
+- Download COCO.
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+cd dataset/scripts/
+sh COCO2017.sh
+```
+
+- Check COCO
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+python dataset/coco.py
+```
+
+- Train on COCO
+
+For example:
+```Shell
+python train.py --cuda -d coco --root path/to/COCO -v yolov1 -bs 16 --max_epoch 150 --wp_epoch 1 --eval_epoch 10 --fp16 --ema --multi_scale
+```
+
+| Model  | Scale |  IP  | AP<sup>val<br>0.5:0.95 | AP<sup>test<br>0.5:0.95 | FPS<sup>3090<br>FP32-bs1 | FLOPs<br><sup>(G) | Params<br><sup>(M) | Weight |
+|--------|-------|------|------------------------|-------------------------|--------------------------|-------------------|--------------------|--------|
+| YOLOv1 |  640  |  √   |   35.5                 |                         |     100                  |   9.0             |   2.3              |  |
+| YOLOv2 |  640  |  √   |                        |                         |                          |   33.5            |   8.3              |  |
+| YOLOv3 |  640  |  √   |                        |                         |                          |   86.7            |   23.0             |  |
+| YOLOv4 |  640  |  √   |                        |                         |                          |   175.4           |   46.5             |  |
+
+*All models are trained with ImageNet pretrained weight (IP). All FLOPs are measured with a 640x640 image size on COCO val2017. The FPS is measured with batch size 1 on 3090 GPU from the model inference to the NMS operation.*
+
+
+
+### VOC
+- Download VOC.
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+cd dataset/scripts/
+sh VOC2007.sh
+sh VOC2012.sh
+```
+
+- Check VOC
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+python dataset/voc.py
+```
+
+- Train on VOC
+
+For example:
+```Shell
+python train.py --cuda -d voc --root path/to/VOCdevkit -v yolov1 -bs 16 --max_epoch 150 --wp_epoch 1 --eval_epoch 10 --fp16 --ema --multi_scale
+```
+
+| Model  | Scale |  IP  | mAP | FPS<sup>3090<br>FP32-bs1 | FLOPs<br><sup>(G) | Params<br><sup>(M) | Weight |
+|--------|-------|------|-----|--------------------------|-------------------|--------------------|--------|
+| YOLOv1 |  640  |  √   |     |                          |   37.8            |   21.3             |  |
+| YOLOv2 |  640  |  √   |     |                          |   53.9            |   30.9             |  |
+| YOLOv3 |  640  |  √   |     |                          |                   |                    |  |
+| YOLOv4 |  640  |  √   |     |                          |                   |                    |  |
+
+*All models are trained with ImageNet pretrained weight (IP). All FLOPs are measured with a 640x640 image size on VOC2007 test. The FPS is measured with batch size 1 on 3090 GPU from the model inference to the NMS operation.*
+
+
+## Train
+### Single GPU
+```Shell
+sh train.sh
+```
+
+You can change the configurations of `train.sh`, according to your own situation.
+
+You also can add `--vis_tgt`  to check the images and targets during the training stage. For example:
+```Shell
+python train.py --cuda -d coco --root path/to/coco -v yolov1 --vis_tgt
+```
+
+### Multi GPUs
+```Shell
+sh train_ddp.sh
+```
+
+You can change the configurations of `train_ddp.sh`, according to your own situation.
+
+**In the event of a training interruption**, you can pass `--resume` the latest training
+weight path (`None` by default) to resume training. For example:
+
+```Shell
+python train.py \
+        --cuda \
+        -d coco \
+        -v yolov1 \
+        -bs 16 \
+        --max_epoch 300 \
+        --wp_epoch 3 \
+        --eval_epoch 10 \
+        --ema \
+        --fp16 \
+        --resume weights/coco/yolov1/yolov1_epoch_151_39.24.pth
+```
+
+Then, training will continue from 151 epoch.
+
+## Test
+```Shell
+python test.py -d coco \
+               --cuda \
+               -v yolov1 \
+               --img_size 640 \
+               --weight path/to/weight \
+               --root path/to/dataset/ \
+               --show
+```
+
+## Evaluation
+```Shell
+python eval.py -d coco-val \
+               --cuda \
+               -v yolov1 \
+               --img_size 640 \
+               --weight path/to/weight \
+               --root path/to/dataset/ \
+               --show
+```
+
+## Demo
+I have provide some images in `data/demo/images/`, so you can run following command to run a demo:
+
+```Shell
+python demo.py --mode image \
+               --path_to_img data/demo/images/ \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```
+
+If you want run a demo of streaming video detection, you need to set `--mode` to `video`, and give the path to video `--path_to_vid`。
+
+```Shell
+python demo.py --mode video \
+               --path_to_img data/demo/videos/your_video \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```
+
+If you want run video detection with your camera, you need to set `--mode` to `camera`。
+
+```Shell
+python demo.py --mode camera \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```

README_CN.md

@@ -0,0 +1,205 @@
+# PyTorch_YOLO_Tutorial
+YOLO 教程
+
+## 配置运行环境
+- 首先，我们建议使用Anaconda来创建一个conda的虚拟环境
+```Shell
+conda create -n yolo python=3.6
+```
+
+- 然后, 请激活已创建的虚拟环境
+```Shell
+conda activate yolo
+```
+
+- 接着，配置环境:
+```Shell
+pip install -r requirements.txt 
+```
+
+项目作者所使用的环境配置:
+- PyTorch = 1.9.1
+- Torchvision = 0.10.1
+
+为了能够正常运行该项目的代码，请确保您的torch版本为1.x系列。
+
+
+## 训练配置
+|   配置                  |                   |
+|------------------------|--------------------|
+| 单个GPU上的batch size   | 16                 |
+| 初始学习率              | 0.01               |
+| Warnmup策略            | 线性warmup策略      |
+| 学习率策略              | 线性学习了衰减策略  |
+| 训练优化器              | SGD               |
+| 多尺度训练              | True              |
+
+## 实验结果
+### COCO
+- 下载 COCO.
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+cd dataset/scripts/
+sh COCO2017.sh
+```
+
+- 检查 COCO
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+python dataset/coco.py
+```
+
+当COCO数据集的路径修改正确后，运行上述命令应该会看到COCO数据的可视化图像。
+
+- 使用COCO训练模型
+
+For example:
+```Shell
+python train.py --cuda -d coco --root path/to/COCO -v yolov1 -bs 16 --max_epoch 150 --wp_epoch 1 --eval_epoch 10 --fp16 --ema --multi_scale
+```
+
+**P5-Model on COCO:**
+
+| Model  | Scale |  IP  | AP<sup>val<br>0.5:0.95 | AP<sup>test<br>0.5:0.95 | FPS<sup>3090<br>FP32-bs1 | FLOPs<br><sup>(G) | Params<br><sup>(M) | Weight |
+|--------|-------|------|------------------------|-------------------------|--------------------------|-------------------|--------------------|--------|
+| YOLOv1 |  640  |  √   |   35.5                 |                         |     100                  |   9.0             |   2.3              |  |
+| YOLOv2 |  640  |  √   |                        |                         |                          |   33.5            |   8.3              |  |
+| YOLOv3 |  640  |  √   |                        |                         |                          |   86.7            |   23.0             |  |
+| YOLOv4 |  640  |  √   |                        |                         |                          |   175.4           |   46.5             |  |
+
+*所有的模型都使用了ImageNet预训练权重（IP），所有的FLOPs都是在COCO-val数据集上以640x640或1280x1280的输入尺寸来测试的。FPS指标是在一张3090型号的GPU上以batch size=1的输入来测试的，请注意，测速的内容包括模型前向推理、后处理以及NMS操作。*
+
+### VOC
+- 下载 VOC.
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+cd dataset/scripts/
+sh VOC2007.sh
+sh VOC2012.sh
+```
+
+- 检查 VOC
+```Shell
+cd <PyTorch_YOLO_Tutorial>
+python dataset/voc.py
+```
+
+- 使用 VOC 训练模型
+
+For example:
+```Shell
+python train.py --cuda -d voc --root path/to/VOC -v yolov1 -bs 16 --max_epoch 150 --wp_epoch 1 --eval_epoch 10 --fp16 --ema --multi_scale
+```
+
+**P5-Model on COCO:**
+
+| Model  | Scale |  IP  | mAP | FPS<sup>3090<br>FP32-bs1 | FLOPs<br><sup>(G) | Params<br><sup>(M) | Weight |
+|--------|-------|------|-----|--------------------------|-------------------|--------------------|--------|
+| YOLOv1 |  640  |  √   |     |                          |   37.8            |   21.3             |  |
+| YOLOv2 |  640  |  √   |     |                          |   53.9            |   30.9             |  |
+| YOLOv3 |  640  |  √   |     |                          |                   |                    |  |
+| YOLOv4 |  640  |  √   |     |                          |                   |                    |  |
+
+*所有的模型都使用了ImageNet预训练权重（IP），所有的FLOPs都是在VOC2007 test数据集上以640x640或1280x1280的输入尺寸来测试的。FPS指标是在一张3090型号的GPU上以batch size=1的输入来测试的，请注意，测速的内容包括模型前向推理、后处理以及NMS操作。*
+
+## 训练
+### 使用单个GPU来训练
+```Shell
+sh train.sh
+```
+
+使用者可以根据自己的情况来调整`train.sh`文件中的配置，以便在自己的本地上顺利训练模型。
+
+如果使用者想查看训练时所使用的数据，可以在训练命令中输入`--vsi_tgt`参数，例如：
+```Shell
+python train.py --cuda -d coco --root path/to/coco -v yolov1 --vis_tgt
+```
+
+### 使用多个GPU来训练
+```Shell
+sh train_ddp.sh
+```
+
+使用者可以根据自己的情况来调整`train_ddp.sh`文件中的配置，以便在自己的本地上顺利训练模型。
+
+**当训练突然中断时**, 使用者可以在训练命令中传入`--resume`参数，并指定最新保存的权重文件（默认为`None`），以便继续训练。例如：
+
+```Shell
+python train.py \
+        --cuda \
+        -d coco \
+        -v yolov1 \
+        -bs 16 \
+        --max_epoch 150 \
+        --wp_epoch 1 \
+        --eval_epoch 10 \
+        --ema \
+        --fp16 \
+        --resume weights/coco/yolov1/yolov1_epoch_151_39.24.pth
+```
+
+## 测试
+使用者可以参考下面的给出的例子在相应的数据集上去测试训练好的模型，正常情况下，使用者将会看到检测结果的可视化图像。
+
+```Shell
+python test.py -d coco \
+               --cuda \
+               -v yolov1 \
+               --img_size 640 \
+               --weight path/to/weight \
+               --root path/to/dataset/ \
+               --show
+```
+
+## 验证
+使用者可以参考下面的给出的例子在相应的数据集上去验证训练好的模型，正常情况下，使用者将会看到COCO风格的AP结果输出。
+
+```Shell
+python eval.py -d coco-val \
+               --cuda \
+               -v yolov1 \
+               --img_size 640 \
+               --weight path/to/weight \
+               --root path/to/dataset/ \
+               --show
+```
+
+如果使用者想测试模型在COCO test-dev数据集上的AP指标，可以遵循以下步骤：
+
+- 将上述命令中的`coco-val`修改为`coco-test`，然后运行；
+- 运行结束后，将会得到一个名为`coco_test-dev.json`的文件；
+- 将其压缩为一个`.zip`，按照COCO官方的要求修改压缩文件的名称，例如``;
+- 按照COCO官方的要求，将该文件上传至官方的服务器去计算AP。
+
+## Demo
+本项目在`data/demo/images/`文件夹中提供了一些图片，使用者可以运行下面的命令来测试本地的图片：
+
+```Shell
+python demo.py --mode image \
+               --path_to_img data/demo/images/ \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```
+
+如果使用者想在本地的视频上去做测试，那么你需要将上述命令中的`--mode image`修改为`--mode video`，并给`--path_to_vid`传入视频所在的文件路径，例如：
+
+```Shell
+python demo.py --mode video \
+               --path_to_img data/demo/videos/your_video \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```
+
+如果使用者想用本地的摄像头（如笔记本的摄像头）去做测试，那么你需要将上述命令中的`--mode image`修改为`--mode camera`，例如：
+
+```Shell
+python demo.py --mode camera \
+               -v yolov1 \
+               --img_size 640 \
+               --cuda \
+               --weight path/to/weight
+```

train.sh

@@ -8,7 +8,6 @@ python train.py \
         -size 640 \
         --wp_epoch 1 \
         --max_epoch 150 \
-        --step_epoch 90 120 \
         --eval_epoch 10 \
         --ema \
         --fp16 \