CodeCamp #147 [Doc] Add Chinese version of train & test tutorial (2355)
doc modify part of content changed parts of content modified Update docs/zh_cn/user_guides/4_train_test.md Co-authored-by: 谢昕辰 <xiexinch@outlook.com>pull/2448/head
BLUE-coconut
MeowZheng
parent
665fa4c736
commit
82a48ce1bf
|
|
@ -1,159 +0,0 @@
|
|||
## 训练一个模型（待更新）
|
||||
|
||||
MMSegmentation 可以执行分布式训练和非分布式训练，分别使用 `MMDistributedDataParallel` 和 `MMDataParallel` 命令。
|
||||
|
||||
所有的输出(日志 log 和检查点 checkpoints )将被保存到工作路径文件夹里，它可以通过配置文件里的 `work_dir` 指定。
|
||||
|
||||
在一定迭代轮次后，我们默认在验证集上评估模型表现。您可以在训练配置文件中添加间隔参数来改变评估间隔。
|
||||
|
||||
```python
|
||||
evaluation = dict(interval=4000) # 每4000 iterations 评估一次模型的性能
|
||||
```
|
||||
|
||||
**\*重要提示\***: 在配置文件里的默认学习率是针对4卡 GPU 和2张图/GPU (此时 batchsize = 4x2 = 8)来设置的。
|
||||
同样，您也可以使用8卡 GPU 和 1张图/GPU 的设置，因为所有的模型均使用 cross-GPU 的 SyncBN 模式。
|
||||
|
||||
我们可以在训练速度和 GPU 显存之间做平衡。当模型或者 Batch Size 比较大的时，可以传递`--cfg-options model.backbone.with_cp=True` ，使用 `with_cp` 来节省显存，但是速度会更慢，因为原先使用 `with_cp` 时，是逐层反向传播(Back Propagation, BP)，不会保存所有的梯度。
|
||||
|
||||
### 使用单台机器训练
|
||||
|
||||
#### 使用单卡 GPU 训练
|
||||
|
||||
```shell
|
||||
python tools/train.py ${CONFIG_FILE} [可选参数]
|
||||
```
|
||||
|
||||
如果您想在命令里定义工作文件夹路径，您可以添加一个参数`--work-dir ${工作路径}`。
|
||||
|
||||
#### 使用 CPU 训练
|
||||
|
||||
如果计算机没有 GPU，那么使用 CPU 训练的流程和使用单 GPU 训练的流程一致。如果计算机有 GPU 但是想使用 CPU，我们仅需要在训练流程开始前禁用 GPU。
|
||||
|
||||
```shell
|
||||
export CUDA_VISIBLE_DEVICES=-1
|
||||
```
|
||||
|
||||
之后运行单 GPU 训练脚本即可。
|
||||
|
||||
```{warning}
|
||||
我们不推荐用户使用 CPU 进行训练，这太过缓慢。我们支持这个功能是为了方便用户在没有 GPU 的机器上进行调试。
|
||||
```
|
||||
|
||||
#### 使用多卡 GPU 训练
|
||||
|
||||
```shell
|
||||
sh tools/dist_train.sh ${CONFIG_FILE} ${GPUS} [可选参数]
|
||||
```
|
||||
|
||||
可选参数可以为:
|
||||
|
||||
- `--no-validate` (**不推荐**): 训练时代码库默认会在每 k 轮迭代后在验证集上进行评估，如果不需评估使用命令 `--no-validate`
|
||||
- `--work-dir ${工作路径}`: 在配置文件里重写工作路径文件夹
|
||||
- `--resume-from ${检查点文件}`: 继续使用先前的检查点 (checkpoint) 文件（可以继续训练过程）
|
||||
- `--load-from ${检查点文件}`: 从一个检查点 (checkpoint) 文件里加载权重（对另一个任务进行精调）
|
||||
- `--deterministic`: 选择此模式会减慢训练速度，但结果易于复现
|
||||
|
||||
`resume-from` 和 `load-from` 的区别:
|
||||
|
||||
- `resume-from` 加载出模型权重和优化器状态包括迭代轮数等
|
||||
- `load-from` 仅加载模型权重，从第0轮开始训练
|
||||
|
||||
示例:
|
||||
|
||||
```shell
|
||||
# 模型的权重和日志将会存储在这个路径下： WORK_DIR=work_dirs/pspnet_r50-d8_512x512_80k_ade20k/
|
||||
# 如果work_dir没有被设定，它将会被自动生成
|
||||
sh tools/dist_train.sh configs/pspnet/pspnet_r50-d8_512x512_80k_ade20k.py 8 --work_dir work_dirs/pspnet_r50-d8_512x512_80k_ade20k/ --deterministic
|
||||
```
|
||||
|
||||
**注意**: 在训练时，模型的和日志保存在“work_dirs/”下的配置文件的相同文件夹结构中。不建议使用自定义的“work_dirs/”，因为验证脚本可以从配置文件名中推断工作目录。如果你想在其他地方保存模型的权重，请使用符号链接，例如:
|
||||
|
||||
```shell
|
||||
ln -s ${YOUR_WORK_DIRS} ${MMSEG}/work_dirs
|
||||
```
|
||||
|
||||
#### 在单个机器上启动多个任务
|
||||
|
||||
如果您在单个机器上启动多个任务，例如在8卡 GPU 的一个机器上有2个4卡 GPU 的训练任务，您需要特别对每个任务指定不同的端口（默认为29500）来避免通讯冲突。否则，将会有报错信息 `RuntimeError: Address already in use`。
|
||||
|
||||
如果您使用命令 `dist_train.sh` 来启动一个训练任务，您可以在命令行的用环境变量 `PORT` 设置端口:
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 PORT=29500 sh tools/dist_train.sh ${CONFIG_FILE} 4
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 PORT=29501 sh tools/dist_train.sh ${CONFIG_FILE} 4
|
||||
```
|
||||
|
||||
### 使用多台机器训练
|
||||
|
||||
如果您想使用由 ethernet 连接起来的多台机器， 您可以使用以下命令:
|
||||
|
||||
在第一台机器上:
|
||||
|
||||
```shell
|
||||
NNODES=2 NODE_RANK=0 PORT=$MASTER_PORT MASTER_ADDR=$MASTER_ADDR sh tools/dist_train.sh $CONFIG $GPUS
|
||||
```
|
||||
|
||||
在第二台机器上:
|
||||
|
||||
```shell
|
||||
NNODES=2 NODE_RANK=1 PORT=$MASTER_PORT MASTER_ADDR=$MASTER_ADDR sh tools/dist_train.sh $CONFIG $GPUS
|
||||
```
|
||||
|
||||
但是，如果您不使用高速网路连接这几台机器的话，训练将会非常慢。
|
||||
|
||||
### 使用slurm管理任务
|
||||
|
||||
Slurm是一个很好的计算集群作业调度系统。在由Slurm管理的集群中，可以使用slurm_train.sh来进行训练。它同时支持单节点和多节点训练。
|
||||
|
||||
在多台机器上训练：
|
||||
|
||||
```shell
|
||||
[GPUS=${GPUS}] sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} ${CONFIG_FILE} --work-dir ${WORK_DIR}
|
||||
```
|
||||
|
||||
这里有一个在dev分区上使用16块GPUs来训练PSPNet的例子:
|
||||
|
||||
```shell
|
||||
GPUS=16 sh tools/slurm_train.sh dev pspr50 configs/pspnet/pspnet_r50-d8_512x1024_40k_cityscapes.py work_dirs/pspnet_r50-d8_512x1024_40k_cityscapes/
|
||||
```
|
||||
|
||||
当使用 `slurm_train.sh` 在一个节点上启动多个任务时，需要指定不同的端口号，这里提供了三种设置:
|
||||
|
||||
方式1：
|
||||
|
||||
在`config1.py`中设置:
|
||||
|
||||
```python
|
||||
dist_params = dict(backend='nccl', port=29500)
|
||||
```
|
||||
|
||||
在`config2.py`中设置:
|
||||
|
||||
```python
|
||||
dist_params = dict(backend='nccl', port=29501)
|
||||
```
|
||||
|
||||
然后就可以使用config1.py和config2.py启动两个作业:
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config1.py tmp_work_dir_1
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config2.py tmp_work_dir_2
|
||||
```
|
||||
|
||||
方式2:
|
||||
|
||||
您可以设置不同的通信端口，而不需要修改配置文件，但必须设置“cfg-options”，以覆盖配置文件中的默认端口。
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config1.py tmp_work_dir_1 --cfg-options dist_params.port=29500
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config2.py tmp_work_dir_2 --cfg-options dist_params.port=29501
|
||||
```
|
||||
|
||||
方式3:
|
||||
|
||||
您可以使用环境变量’ MASTER_PORT ‘在命令中设置端口:
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 MASTER_PORT=29500 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config1.py tmp_work_dir_1
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 MASTER_PORT=29501 sh tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config2.py tmp_work_dir_2
|
||||
```
|
||||
|
|
@ -0,0 +1,225 @@
|
|||
# 教程4：使用现有模型进行训练和测试
|
||||
|
||||
MMSegmentation 支持在多种设备上训练和测试模型。如下文，具体方式分别为单GPU、分布式以及计算集群的训练和测试。通过本教程，您将知晓如何用 MMSegmentation 提供的脚本进行训练和测试。
|
||||
|
||||
## 在单GPU上训练和测试
|
||||
|
||||
### 在单GPU上训练
|
||||
|
||||
`tools/train.py` 文件提供了在单GPU上部署训练任务的方法。
|
||||
|
||||
基础用法如下:
|
||||
|
||||
```shell
|
||||
python tools/train.py ${配置文件} [可选参数]
|
||||
```
|
||||
|
||||
- `--work-dir ${工作路径}`: 重新指定工作路径
|
||||
- `--amp`: 使用自动混合精度计算
|
||||
- `--resume`: 从工作路径中保存的最新检查点文件（checkpoint）恢复训练
|
||||
- `--cfg-options ${需更覆盖的配置}`: 覆盖已载入的配置中的部分设置，并且 以 xxx=yyy 格式的键值对 将被合并到配置文件中。
|
||||
比如： '--cfg-option model.encoder.in_channels=6'， 更多细节请看[指导](./1_config.md#Modify-config-through-script-arguments)。
|
||||
|
||||
下面是对于多GPU测试的可选参数:
|
||||
|
||||
- `--launcher`: 执行器的启动方式。允许选择的参数值有 `none`, `pytorch`, `slurm`, `mpi`。特别的，如果设置为none，测试将非分布式模式下进行。
|
||||
- `--local_rank`: 分布式中进程的序号。如果没有指定，默认设置为0。
|
||||
|
||||
**注意：** 命令行参数 `--resume` 和在配置文件中的参数 `load_from` 的不同之处：
|
||||
|
||||
`--resume` 只决定是否继续使用工作路径中最新的检查点，它常常用于恢复被意外打断的训练。
|
||||
|
||||
`load_from` 会明确指定被载入的检查点文件，且训练迭代器将从0开始，通常用于微调模型。
|
||||
|
||||
如果您希望从指定的检查点上恢复训练您可以使用：
|
||||
|
||||
```python
|
||||
python tools/train.py ${配置文件} --resume --cfg-options load_from=${检查点}
|
||||
```
|
||||
|
||||
**在 CPU 上训练**: 如果机器没有 GPU，则在 CPU 上训练的过程是与单GPU训练一致的。如果机器有 GPU 但是不希望使用它们，我们只需要在训练前通过以下方式关闭 GPU 训练功能。
|
||||
|
||||
```shell
|
||||
export CUDA_VISIBLE_DEVICES=-1
|
||||
```
|
||||
|
||||
然后运行[上方](#在单GPU上训练)脚本。
|
||||
|
||||
### 在单GPU上测试
|
||||
|
||||
`tools/test.py` 文件提供了在单 GPU 上启动测试任务的方法。
|
||||
|
||||
基础用法如下:
|
||||
|
||||
```shell
|
||||
python tools/test.py ${配置文件} ${模型权重文件} [可选参数]
|
||||
```
|
||||
|
||||
这个工具有几个可选参数，包括：
|
||||
|
||||
- `--work-dir`: 如果指定了路径，结果会保存在该路径下。如果没有指定则会保存在 `work_dirs/{配置文件名}` 路径下.
|
||||
- `--show`: 当 `--show-dir` 没有指定时，可以使用该参数，在程序运行过程中显示预测结果。
|
||||
- `--show-dir`: 绘制了分割掩膜图片的存储文件夹。如果指定了该参数，则可视化的分割掩膜将被保存到 `work_dir/timestamp/{指定路径}`.
|
||||
- `--wait-time`: 多次可视化结果的时间间隔。当 `--show` 为激活状态时发挥作用。默认为2。
|
||||
- `--cfg-options`: 如果被具体指定，以 xxx=yyy 形式的键值对将被合并入配置文件中。
|
||||
|
||||
**在CPU上测试**: 如果机器没有GPU，则在CPU上训练的过程是与单GPU训练一致的。如果机器有GPU，但是不希望使用它们，我们只需要在训练前通过以下方式关闭GPUs训练功能。
|
||||
|
||||
```shell
|
||||
export CUDA_VISIBLE_DEVICES=-1
|
||||
```
|
||||
|
||||
然后运行[上方](#在单GPU上测试)脚本。
|
||||
|
||||
## 多GPU、多机器上训练和测试
|
||||
|
||||
### 在多GPU上训练
|
||||
|
||||
OpenMMLab2.0 通过 `MMDistributedDataParallel`实现 **分布式** 训练。
|
||||
|
||||
`tools/dist_train.sh` 文件提供了在在多GPU上部署训练任务的方法。
|
||||
|
||||
基础用法如下:
|
||||
|
||||
```shell
|
||||
sh tools/dist_train.sh ${配置文件} ${GPU数量} [可选参数]
|
||||
```
|
||||
|
||||
可选参数与[上方](#在单GPU上训练)相同并且还增加了可以指定gpu数量的参数。
|
||||
|
||||
示例:
|
||||
|
||||
```shell
|
||||
# 模型训练的检查点和日志保存在这个路径下： WORK_DIR=work_dirs/pspnet_r50-d8_4xb4-80k_ade20k-512x512/
|
||||
# 如果工作路径没有被设定，它将会被自动生成。
|
||||
sh tools/dist_train.sh configs/pspnet/pspnet_r50-d8_4xb4-80k_ade20k-512x512.py 8 --work-dir work_dirs/pspnet_r50-d8_4xb4-80k_ade20k-512x512
|
||||
```
|
||||
|
||||
**注意**: 在训练过程中，检查点和日志保存在`work_dirs/`下的配置文件的相同文件夹结构下。
|
||||
不推荐自定义的工作路径，因为评估脚本依赖于源自配置文件名的路径。如果您希望将权重保存在其他地方，请用符号链接，例如：
|
||||
|
||||
```shell
|
||||
ln -s ${您的工作路径} ${MMSEG 路径}/work_dirs
|
||||
```
|
||||
|
||||
### 在多GPU上测试
|
||||
|
||||
`tools/dist_test.sh` 文件提供了在多GPU上启动测试任务的方法。
|
||||
|
||||
基础用法如下:
|
||||
|
||||
```shell
|
||||
sh tools/dist_test.sh ${配置文件} ${检查点文件} ${GPU数量} [可选参数]
|
||||
```
|
||||
|
||||
可选参数与[上方](#在单GPU上测试)相同并且增加了可以指定 gpu 数量的参数。
|
||||
|
||||
示例:
|
||||
|
||||
```shell
|
||||
./tools/dist_test.sh configs/pspnet/pspnet_r50-d8_4xb2-40k_cityscapes-512x1024.py \
|
||||
checkpoints/pspnet_r50-d8_512x1024_40k_cityscapes_20200605_003338-2966598c.pth 4
|
||||
```
|
||||
|
||||
### 在单台机器上启动多个任务
|
||||
|
||||
如果您在单个机器上运行多个任务，比如：在8卡GPU的单个机器上执行2个各需4卡GPU的训练任务，您需要为每个任务具体指定不同端口（默认29500），从而避免通讯冲突。否则，会有报错信息——`RuntimeError: Address already in use`（运行错误：地址被使用）。
|
||||
|
||||
如果您使用 `dist_train.sh` 来启动训练任务，您可以通过环境变量 `PORT` 设置端口。
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 PORT=29500 sh tools/dist_train.sh ${配置文件} 4
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 PORT=29501 sh tools/dist_train.sh ${配置文件} 4
|
||||
```
|
||||
|
||||
### 在多台机器上训练
|
||||
|
||||
MMSegmentation 的分布式训练依赖 `torch.distributed`。
|
||||
因此， 可以通过 PyTorch 的 [运行工具 launch utility](https://pytorch.org/docs/stable/distributed.html#launch-utility) 来进行分布式训练。
|
||||
|
||||
如果您启动的多台机器简单地通过以太网连接，您可以直接运行下方命令：
|
||||
|
||||
在第一个机器上:
|
||||
|
||||
```shell
|
||||
NNODES=2 NODE_RANK=0 PORT=${主节点端口} MASTER_ADDR=${主节点地址} sh tools/dist_train.sh ${配置文件} ${GPUS}
|
||||
```
|
||||
|
||||
在第二个机器上:
|
||||
|
||||
```shell
|
||||
NNODES=2 NODE_RANK=1 PORT=${主节点端口} MASTER_ADDR=${主节点地址} sh tools/dist_train.sh ${配置文件} ${GPUS}
|
||||
```
|
||||
|
||||
通常，如果您没有使用像无限带宽一类的高速网络，这个会过程比较慢。
|
||||
|
||||
## 通过 Slurm 管理任务
|
||||
|
||||
[Slurm](https://slurm.schedmd.com/) 是一个很好的计算集群作业调度系统。
|
||||
|
||||
### 通过 Slurm 在集群上训练
|
||||
|
||||
在一个由Slurm管理的集群上，您可以使用`slurm_train.sh`来启动训练任务。它同时支持单节点和多节点的训练。
|
||||
|
||||
基础用法如下：
|
||||
|
||||
```shell
|
||||
[GPUS=${GPUS}] sh tools/slurm_train.sh ${分区} ${任务名} ${配置文件} [可选参数]
|
||||
```
|
||||
|
||||
下方是一个通过名为 `dev` 的 Slurm 分区，调用4个 GPU 来训练 PSPNet，并设置工作路径为共享文件系统。
|
||||
|
||||
```shell
|
||||
GPUS=4 sh tools/slurm_train.sh dev pspnet configs/pspnet/pspnet_r50-d8_512x1024_40k_cityscapes.py --work-dir work_dir/pspnet
|
||||
```
|
||||
|
||||
您可以检查 [源码](../../../tools/slurm_train.sh) 来查看全部的参数和环境变量。
|
||||
|
||||
### 通过 Slurm 在集群上测试
|
||||
|
||||
与训练任务相同， MMSegmentation 提供 `slurm_test.sh` 文件来启动测试任务。
|
||||
|
||||
基础用法如下：
|
||||
|
||||
```shell
|
||||
[GPUS=${GPUS}] sh tools/slurm_test.sh ${分区} ${任务名} ${配置文件} ${检查点文件} [可选参数]
|
||||
```
|
||||
|
||||
您可以通过 [源码](../../../tools/slurm_test.sh) 来查看全部的参数和环境变量。
|
||||
|
||||
**注意：** 使用 Slurm 时，需要设置端口，可从以下方式中选取一种。
|
||||
|
||||
1. 我们更推荐的通过`--cfg-options`设置端口，因为这不会改变原始配置：
|
||||
|
||||
```shell
|
||||
GPUS=4 GPUS_PER_NODE=4 sh tools/slurm_train.sh ${分区} ${任务名} config1.py ${工作路径} --cfg-options env_cfg.dist_cfg.port=29500
|
||||
GPUS=4 GPUS_PER_NODE=4 sh tools/slurm_train.sh ${任务名} ${工作路径} config2.py ${工作路径} --cfg-options env_cfg.dist_cfg.port=29501
|
||||
```
|
||||
|
||||
2. 通过修改配置文件设置不同的通讯端口：
|
||||
|
||||
在 `config1.py`中:
|
||||
|
||||
```python
|
||||
enf_cfg = dict(dist_cfg=dict(backend='nccl', port=29500))
|
||||
```
|
||||
|
||||
在 `config2.py`中：
|
||||
|
||||
```python
|
||||
enf_cfg = dict(dist_cfg=dict(backend='nccl', port=29501))
|
||||
```
|
||||
|
||||
然后您可以通过 config1.py 和 config2.py 同时启动两个任务：
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 sh tools/slurm_train.sh ${分区} ${任务名} config1.py ${工作路径}
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 sh tools/slurm_train.sh ${分区} ${任务名} config2.py ${工作路径}
|
||||
```
|
||||
|
||||
3. 在命令行中通过环境变量 `MASTER_PORT` 设置端口 ：
|
||||
|
||||
```shell
|
||||
CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 MASTER_PORT=29500 sh tools/slurm_train.sh ${分区} ${任务名} config1.py ${工作路径}
|
||||
CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 MASTER_PORT=29501 sh tools/slurm_train.sh ${分区} ${任务名} config2.py ${工作路径}
|
||||
```
|
||||
Loading…
Reference in New Issue