Unet_Industrial (TensorFlow)
本仓库是在MLU上基于TensorFlow框架实现的网络，支持训练与推理。
目录 (Table of Contents)
Unet_industrial是一个呈U型结构的语义分割模型。原始论文为Unet_industrial.
Unet_industrial网络的TensorFlow原生代码实现可参考：这里。
| Models | Framework | Supported MLU | Supported Data Precision | Multi-GPUs | Multi-Nodes |
|---|---|---|---|---|---|
| Unet_industrial | TensorFlow | MLU370-X8 | FP16/FP32 | Yes | Not Tested |
| Models | Framework | Supported MLU | Supported Data Precision | Jit/Eager Support |
|---|---|---|---|---|
| Unet_industrial | TensorFlow | MLU370-X4/X8 | FP32 | Eager |
Unet_industrial模型的训练推理参数存在于unet2d.py内，同时受到run_scripts/内的shell脚本的共同影响。
（1）run_scripts/内的shell脚本涉及到的常用参数及含义如下表所示：
| 参数 | 作用 | 默认值 |
|---|---|---|
| exec_mode | 设置网络的运行模式 | None |
| data_dir | 存放数据集的目录 | None |
| results_dir | 存放结果的目录 | None |
| use_hvd | 是否使用horovod进行分布式训练 | True |
| activation_fn | 选择激活函数 | relu |
| iter_unit | 迭代的单位 | batch |
| batch_size | 更改训练的batch_size | None |
| num_iter | 迭代的次数 | None |
| dataset_name | 数据集的名称 | None |
| dataset_classID | 更改训练的ClassID | None |
| data_format | 数据格式 | NCHW |
| learning_rate | 学习率 | 1e-4 |
| learning_rate_decay_factor | 学习率衰减系数 | 0.8 |
| learning_rate_decay_steps | 学习率衰减步数 | 500 |
| rmsprop_momentum | rmsprop 优化器 momentum 系数 | 0.8 |
| loss_fn_name | 选择损失函数 | adaptive_loss |
| weight_decay | 权重衰减系数 | 1e-5 |
| weight_init_method | 权重初始化方法 | he_normal |
| display_every | 隔多少次迭代显示一次 | 500 |
| debug_verbosity | 详细级别：最低 0，1 层创建调试信息，2 层 + var 创建调试信息。 | 0 |
| use_gpu | 是否使用gpu | False |
| use_amp | 是否使用amp模式 | False |
| use_performance | 是否使用 use_performance 测试工具 | False |
| use_profiler | 是否使用 profiler 工具 | False |
下面将详细展示如何在 Cambricon TensorFlow上完成Unet_industrial的训练与推理。
- Linux常见操作系统版本(如Ubuntu16.04，Ubuntu18.04，CentOS7.x等)，安装docker(>=v18.00.0)应用程序；
- 服务器装配好寒武纪MLU300系列计算板卡，如需进行训练，则需装配MLU370-X8，若只需推理，则装配MLU370-X4/X8均可；
- Cambricon Driver >=v4.20.6；
- CNTensorFlow == 1.15.5;
- 若不具备以上软硬件条件，可前往寒武纪云平台注册并试用@TODO
容器环境通常有两种搭建方式，一种是基于基础镜像，另一种则是基于DOCKERFILE。
(1)基于base docker image的容器环境搭建
a)导入镜像
下载Cambricon TensorFlow 镜像并参考如下命令加载镜像：
docker load -i Your_Cambricon_TensorFlow_Image.tar.gz
b)启动容器
run_docker.sh示例如下，根据本地的镜像版本，修改如下示例中的IMAGE_NAME和IMAGE_TAG变量后再运行bash run_docker.sh即可启动容器。
#!/bin/bash
# Below is a sample of run_docker.sh.
# Modify the YOUR_IMAGE_NAME according to your own environment.
# For instance,
# IMAGE_NAME=tensorflow1-1.15.0-x86_64-ubuntu18.04
# IMAGE_TAG=latest
IMAGE_NAME=YOUR_IMAGE_NAME
IMAGE_TAG=YOUR_IMAGE_TAG
export MY_CONTAINER="tf1_unet2d_tensorflow_modelzoo"
num=`docker ps -a|grep "$MY_CONTAINER"|wc -l`
echo $num
echo $MY_CONTAINER
if [ 0 -eq $num ];then
xhost +
docker run -it --name="${MY_CONTAINER}" \
--net=host \
--privileged=true \
--cap-add=sys_ptrace \
--shm-size="16g" \
-v /usr/bin/cnmon:/usr/bin/cnmon \
-v /data:/data \
--device=/dev/cambricon_dev0 \
--device=/dev/cambricon_ctl \
$IMAGE_NAME:$IMAGE_TAG \
/bin/bash
else
docker start $MY_CONTAINER
docker exec -ti --env COLUMNS=`tput cols` --env LINES=`tput lines` $MY_CONTAINER /bin/bash
fic)下载项目代码
在容器内使用 git clone 下载本仓库代码并进入tensorflow_modelzoo/tensorflow/built-in/Segmentation/UNet_Industrial 目录。
d)安装模型依赖项
# 安装requirements中的依赖库
pip install -r requirements.txt
# 安装性能测试工具(可选)
# 若不开启性能测试（use_performance为False），则无需安装。
cd ../../../../tools/record_time/
pip install .
(2)基于DOCKERFILE的容器环境搭建
a)构建镜像
由于本仓库包含各类网络，如Segmentation类，Classification 类，为避免网络之间可能的依赖项冲突，您可基于DOCKERFILE构建当前网络专属的镜像。详细步骤如下所示：
# 1. 新建并进入文件夹
mkdir dir_for_docker_build
cd dir_for_docker_build
# 2. 使用git clone下载tensorflow_modelzoo仓库
git clone https://gitee.com/cambricon/tensorflow_modelzoo.git
# 3. 进入该网络目录
cd tensorflow_modelzoo/tensorflow/built-in/Segmentation/UNet_Industrial
# 4. 参考 前文 (1)基于base docker image的容器环境搭建 a)小节，获取基础镜像，假设镜像名字为cambricon_tensorflow1:vX.Y.Z-x86_64-ubuntu18.04
# 5. 修改DOCKERFILE内的FROM_IMAGE_NAME的值为cambricon_tensorflow1:vX.Y.Z-x86_64-ubuntu18.04
# 6. 开始基于DOCKERFILE构建镜像
export IMAGE_NAME=unet2d_image
docker build --network=host -t $IMAGE_NAME -f DOCKERFILE ../../../../../
b)创建并启动容器
上一步成功运行后，本地便生成了一个名为unet2d_image的镜像，后续即可基于该镜像创建容器。
# 1. 参考前文(1)基于base docker image的容器环境搭建 b) 小节，修改run_docker.sh 内的IMAGE_NAME为unet2d_image
# 2. 运行run_docker.sh
bash run_docker.sh
本仓库使用的训练数据集是DAGM2007，依照如下文件列表下载：
Class1.zip
Class2.zip
Class3.zip
Class4.zip
Class5.zip
Class6.zip
Class7.zip
Class8.zip
Class9.zip设置完data_dir后，还需要创建如下目录结构：
└── raw_images
└── private
├── Class1
├── ... 接着，运行脚本 python dataset_prosess.py 处理数据集。
进入run_scripts/，该目录内提供了from_scratch的训练脚本。
| Models | Framework | Supported MLU | Data Precision | Cards | Run |
|---|---|---|---|---|---|
| Unet_industrial | TensorFlow | MLU370-X8 | Float32 | 8 | bash Horovod_Unet2d_Float32_2500E_8MLUs.sh |
| Unet_industrial | TensorFlow | MLU370-X8 | AMP | 8 | bash Horovod_Unet2d_AMP_2500E_8MLUs.sh |
| Unet_industrial | TensorFlow | MLU370-X8 | Float32 | 1 | bash Unet2d_Float32_2500E_1MLU.sh |
根据您的实际环境与需求，修改脚本内数据集的路径（env.sh内的DATA_DIR）及其他参数的值。
进入run_scripts/，该目录内提供了单机单卡推理脚本：
| Models | Framework | Supported MLU | Data Precision | Cards | Run |
|---|---|---|---|---|---|
| Unet_industrial | TensorFlow | MLU370 X4/X8 | FP32 | 1 | bash Infer_Unet2d_Float32_1MLU.sh |
Training accuracy results: MLU370-X8
Unet_industrial的训练精度可由模型在测试集上的IoU_THS_0.99表征。在DAGM2007数据集上，以fp32精度类型训练的模型精度如下：
| MLUs | Batch Size(Train)/Batch Size(Test) | EPOCH | IoU_THS_0.99 |
|---|---|---|---|
| 4 | 16/16 | 2500 | 0.978 |
在单机单卡上使用MLU370-X8对训练了2500个EPOCH的checkpoint进行推理，其精度与性能表现如下表所示:
| Models | Jit/Eager | Supported Data Precision | Batch Size | IoU_THS_0.99 | avg_ips |
|---|---|---|---|---|---|
| Unet_industrial | Eager | FP32 | 16 | 0.978 | 75.44 |
您明确了解并同意，以下链接中的软件、数据或者模型由第三方提供并负责维护。在以下链接中出现的任何第三方的名称、商标、标识、产品或服务并不构成明示或暗示与该第三方或其软件、数据或模型的相关背书、担保或推荐行为。您进一步了解并同意，使用任何第三方软件、数据或者模型，包括您提供的任何信息或个人数据（不论是有意或无意地），应受相关使用条款、许可协议、隐私政策或其他此类协议的约束。因此，使用链接中的软件、数据或者模型可能导致的所有风险将由您自行承担。
@TODO