Skip to content

Commit 0064f09

Browse files
ShawnNewShawnNew
authored
[MLU] add docs for mlu. (#5331)
1 parent ef5638c commit 0064f09

File tree

6 files changed

+249
-0
lines changed

6 files changed

+249
-0
lines changed

‎docs/guides/hardware_support/hardware_info_cn.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
| AI 加速芯片 | | 海光 | 海光 DCU | [安装](./rocm_docs/paddle_install_cn.html#wheel) | [源码编译](./rocm_docs/paddle_install_cn.html#anzhuangfangshier-tongguoyuanmabianyianzhuang) | ✔️ | [支持模型](./rocm_docs/paddle_rocm_cn.html) |
1313
| AI 加速芯片 | XPU | 百度 | 昆仑 K200、R200 等 | [安装](./xpu_docs/paddle_install_xpu2_cn.html#wheel) | [源码编译](./xpu_docs/paddle_install_xpu2_cn.html#xpu) | | [支持模型](./xpu_docs/paddle_2.0_xpu2_cn.html) |
1414
| AI 加速芯片 | IPU | Graphcore | GC200 | | [源码编译](./ipu_docs/paddle_install_cn.html) | | |
15+
| AI 加速芯片 | MLU | 寒武纪 | MLU370 系列 | [安装](./mlu_docs/paddle_install_cn.html) | [源码编译](./mlu_docs/paddle_install_cn.html#anzhuangfangshier-tongguoyuanmabianyianzhuang) | | ✔️ |
1516

1617
## Paddle Inference
1718

@@ -21,6 +22,7 @@
2122
| 服务端 GPU | | NVIDIA | 常见 GPU 型号如 V100、T4 等 | [预编译库](https://paddleinference.paddlepaddle.org.cn/user_guides/download_lib.html) | [源码编译](https://paddleinference.paddlepaddle.org.cn/user_guides/source_compile.html) | ✔️ | |
2223
| 移动端 GPU | | NVIDIA | Jetson 系列 | [预编译库](https://paddleinference.paddlepaddle.org.cn/user_guides/download_lib.html) | [源码编译](https://paddleinference.paddlepaddle.org.cn/user_guides/source_compile.html) | ✔️ | |
2324
| AI 加速芯片 | 达芬奇 | 华为 | 昇腾 910 | 即将提供 | | | |
25+
| AI 加速芯片 | MLU | 寒武纪 | MLU370 系列 | [预编译库](./mlu_docs/paddle_install_cn.html#wheel) | [源码编译](./mlu_docs/paddle_install_cn.html#anzhuangfangshier-tongguoyuanmabianyianzhuang) | ✔️ | |
2426
| AI 加速芯片 | | 海光 | 海光 DCU | [预编译库](./rocm_docs/paddle_install_cn.html) | [源码编译](./rocm_docs/paddle_install_cn.html) | ✔️ | [支持模型](./rocm_docs/paddle_rocm_cn.html) |
2527
| AI 加速芯片 | XPU | 百度 | 昆仑 K200、R200 等 | [预编译库](./xpu_docs/inference_install_example_cn.html#wheel) | [源码编译](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/09_hardware_support/xpu_docs/paddle_install_cn.html#id2) | | [支持模型](./xpu_docs/paddle_2.0_xpu_cn.html#xunlianzhichi) |
2628
| 服务端 CPU | ARM | 飞腾 | FT-2000+/64、S2500 | |[源码编译](../../install/compile/arm-compile.html#anchor-1) | | |

‎docs/guides/hardware_support/index_cn.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- `海光 DCU 芯片运行飞桨 <./rocm_docs/index_cn.html>`_ : 介绍如何在海光 DCU 芯片环境上安装和使用飞桨。
1212
- `昇腾 NPU 芯片运行飞桨 <./npu_docs/index_cn.html>`_ : 介绍如何在昇腾环境上安装和使用飞桨。
1313
- `Graphcore IPU 芯片运行飞桨 <./ipu_docs/index_cn.html>`_ : 介绍如何在 IPU 环境上安装和使用飞桨。
14+
- `寒武纪 MLU 芯片运行飞桨 <./mlu_docs/index_cn.html>`_ : 介绍如何在寒武纪 MLU 环境上安装和使用飞桨。
1415

1516
.. toctree::
1617
:hidden:
@@ -20,3 +21,4 @@
2021
rocm_docs/index_cn.rst
2122
npu_docs/index_cn.rst
2223
ipu_docs/index_cn.rst
24+
mlu_docs/index_cn.rst

‎docs/guides/hardware_support/mlu_docs/index_cn.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _cn_mlu_information:
2+
3+
####################
4+
寒武纪 MLU 芯片运行飞桨
5+
####################
6+
7+
寒武纪 MLU370 系列是一款专门用于深度学习的加速卡。Paddle MLU 版当前可以支持在寒武纪 MLU370 系列板卡上进行模型训练。
8+
9+
参考以下内容可快速了解和体验在寒武纪板卡上运行飞桨：
10+
11+
- `飞桨框架寒武纪 MLU 版安装说明 <./paddle_install_cn.html>`_ : 飞桨框架寒武纪 MLU 版安装说明
12+
- `飞桨框架寒武纪 MLU 版训练示例 <./train_example_cn.html>`_ : 飞桨框架寒武纪 MLU 版训练示例
13+
- `飞桨框架寒武纪 MLU 版支持模型 <./paddle_mlu_cn.html>`_ : 飞桨框架寒武纪 MLU 版支持模型列表
14+
15+
16+
.. toctree::
17+
:hidden:
18+
19+
paddle_install_cn.md
20+
train_example_cn.md
21+
paddle_mlu_cn.md

‎docs/guides/hardware_support/mlu_docs/paddle_install_cn.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# 飞桨框架寒武纪 MLU 版安装说明
2+
3+
飞桨框架支持基于 python 的训练和原生预测，当前最新版本为 2.3，提供两种安装方式：
4+
5+
- 通过预编译的 wheel 包安装
6+
- 通过源代码编译安装
7+
8+
## 前置条件
9+
10+
### 板卡安装
11+
12+
寒武纪 MLU370 系列板卡安装，可以参见 [寒武纪官网板卡安装教程](https://developer.cambricon.com/index/curriculum/details/id/38/classid/7.html)。
13+
14+
### 驱动安装
15+
16+
寒武纪驱动安装，可以参见 [寒武纪官网驱动安装](https://www.cambricon.com/docs/sdk_1.6.0/driver_4.20.12/user_guide_4.20.12/index.html)。
17+
18+
**注意**：建议安装寒武纪驱动版本高于 `v4.20.11`。
19+
20+
21+
## 镜像准备
22+
23+
**注意**：当前仅提供基于 Ubuntu18.04 & CNToolkit3.0 的 docker 镜像环境。
24+
25+
首先需要准备支持寒武纪板卡运行环境的 docker 镜像，可以直接从 Paddle 的官方镜像库拉取预先装有 CNToolkit3.0 的 docker 镜像来准备相应的运行环境。
26+
27+
```bash
28+
# 拉取镜像
29+
docker pull registry.baidubce.com/device/paddle-mlu:cntoolkit3.0.2-cnnl1.13.0
30+
31+
# 启动容器，注意这里的参数，例如 shm-size, device 等都需要配置
32+
# 可以通过 `-v` 参数来挂载训练所需的数据集目录，例如 -v /datasets:/datasets
33+
docker run --shm-size=128G \
34+
--net=host \
35+
--cap-add=sys_ptrace \
36+
-v /usr/bin/cnmon:/usr/bin/cnmon \
37+
-v `pwd`:/workspace
38+
-it --privileged \
39+
--name paddle_mlu_$USER \
40+
-w=/workspace
41+
registry.baidubce.com/device/paddle-mlu:cntoolkit3.0.2-cnnl1.13.0 \
42+
/bin/bash
43+
44+
# 检查容器是否可以正确识别寒武纪 MLU 设备
45+
cnmon
46+
47+
# 预期得到以下结果（如下是一台 3 卡机器的信息）：
48+
Sat Oct 8 11:22:22 2022
49+
+------------------------------------------------------------------------------+
50+
| CNMON v4.20.11 |
51+
+-------------------------------+----------------------+-----------------------+
52+
| Card VF Name Firmware | Inited Driver | Util Ecc-Error |
53+
| Fan Temp Pwr:Usage/Cap | Memory-Usage | vMemory-Usage |
54+
|===============================+======================+=======================|
55+
| 0 / MLU370-X4 v1.1.6 | On v4.20.11 | 0% N/A |
56+
| 0% 32C 30 W/ 150 W | 0 MiB/ 23308 MiB | 10240 MiB/1048576 MiB |
57+
+-------------------------------+----------------------+-----------------------+
58+
| 1 / MLU370-X4 v1.1.6 | On v4.20.11 | 0% N/A |
59+
| 0% 33C 25 W/ 150 W | 0 MiB/ 23308 MiB | 10240 MiB/1048576 MiB |
60+
+-------------------------------+----------------------+-----------------------+
61+
| 2 / MLU370-X4 v1.1.6 | On v4.20.11 | 0% N/A |
62+
| 0% 30C 26 W/ 150 W | 0 MiB/ 23308 MiB | 10240 MiB/1048576 MiB |
63+
+-------------------------------+----------------------+-----------------------+
64+
65+
+------------------------------------------------------------------------------+
66+
| Processes: |
67+
| Card VF PID Command Line MLU Memory Usage |
68+
|==============================================================================|
69+
| No running processes found |
70+
+------------------------------------------------------------------------------+
71+
```
72+
73+
## 安装方式一：通过 wheel 包安装
74+
75+
**注意**：当前仅提供 Python 3.7 的 wheel 安装包。
76+
77+
**第一步**：下载 Python3.7 wheel 安装包
78+
79+
```bash
80+
pip install paddlepaddle-mlu==0.0.0 -f https://paddle-device.bj.bcebos.com/develop/mlu/develop.html
81+
```
82+
83+
**第二步**：验证安装包
84+
85+
安装完成之后，运行如下命令。如果出现 PaddlePaddle is installed successfully!，说明已经安装成功。
86+
87+
```bash
88+
python -c "import paddle; paddle.utils.run_check()"
89+
```
90+
91+
## 安装方式二：通过源码编译安装
92+
93+
**注意**：环境准备参见 [镜像准备](./paddle_install_cn.md#jingxiangzhunbei)
94+
95+
**第一步**：下载 Paddle 源码并编译，CMAKE 编译选项含义请参见 [编译选项表](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/install/Tables.html#Compile)
96+
97+
```bash
98+
# 下载源码，默认 develop 分支
99+
git clone https://github.com/PaddlePaddle/Paddle.git
100+
cd Paddle
101+
102+
# 创建编译目录
103+
mkdir build && cd build
104+
105+
# 执行 cmake
106+
cmake .. -DPY_VERSION=3.7 -DWITH_MLU=ON -DWITH_TESTING=ON -DCMAKE_BUILD_TYPE=Release -DWITH_DISTRIBUTE=ON -DWITH_CNCL=ON
107+
108+
# 使用以下命令来编译
109+
make -j$(nproc)
110+
```
111+
112+
**第二步**：安装与验证编译生成的 wheel 包
113+
114+
编译完成之后进入`Paddle/build/python/dist`目录即可找到编译生成的.whl 安装包，安装与验证命令如下：
115+
116+
```bash
117+
# 安装命令
118+
python -m pip install -U paddlepaddle_mlu-0.0.0-cp37-cp37-linux_x86_64.whl
119+
120+
# 验证命令
121+
python -c "import paddle; paddle.utils.run_check()"
122+
```
123+
124+
## 如何卸载
125+
126+
请使用以下命令卸载 Paddle:
127+
128+
```bash
129+
pip uninstall paddlepaddle-mlu
130+
```

‎docs/guides/hardware_support/mlu_docs/paddle_mlu_cn.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
2+
# 飞桨框架寒武纪 MLU 版支持模型
3+
4+
目前 Paddle MLU 版基于寒武纪 MLU370 系列板卡支持以下模型的单机单卡/单机多卡的训练。
5+
6+
## 图像分类
7+
8+
| 模型 | 领域 | 模型链接 | 编程范式 | 训练单机多卡支持 | 训练多机多卡支持 | 推理支持 |
9+
| ----------------- | -------- | ------------------------------------------------------------ | ------------- | -------------- | -------------- | -------------- |
10+
| ResNet50 | 图像分类 | [模型链接](https://github.com/PaddlePaddle/PaddleClas/blob/develop/ppcls/configs/ImageNet/ResNet/ResNet50.yaml) | 动态图 | 支持 | 支持 | 支持 |
11+
| VGG16/19 | 图像分类 | [模型链接](https://github.com/PaddlePaddle/PaddleClas/blob/develop/ppcls/configs/ImageNet/VGG/VGG16.yaml) | 动态图 | 支持 | 支持 | 支持 |
12+
| InceptionV4 | 图像分类 | [模型链接](https://github.com/PaddlePaddle/PaddleClas/blob/develop/ppcls/configs/ImageNet/Inception/InceptionV4.yaml) | 动态图 | 支持 | 支持 | 支持 |
13+
| MobileNetV3 | 图像分类 | [模型链接](https://github.com/PaddlePaddle/PaddleClas/blob/develop/ppcls/configs/ImageNet/MobileNetV3/MobileNetV3_large_x1_0.yaml) | 动态图 | 支持 | 支持 | 支持 |
14+
15+
16+
## 目标检测
17+
18+
| 模型 | 领域 | 模型链接 | 编程范式 | 训练单机多卡支持 | 训练多机多卡支持 | 推理支持 |
19+
| ----------------- | -------- | ------------------------------------------------------------ | ------------- | -------------- | -------------- | -------------- |
20+
| YOLOv3 | 目标检测 | [模型链接](https://github.com/PaddlePaddle/PaddleDetection/tree/develop/configs/yolov3) | 动态图 | 支持 | 支持 | 支持 |
21+
| PP-YOLO | 目标检测 | [模型链接](https://github.com/PaddlePaddle/PaddleDetection/tree/develop/configs/ppyolo) | 动态图 | 支持 | 支持 | 支持 |
22+
| SSD | 目标检测 | [模型链接](https://github.com/PaddlePaddle/PaddleDetection/tree/develop/configs/ssd) | 动态图 | 支持 | 支持 | 支持 |
23+
| Mask R-CNN | 目标检测 | [模型链接](https://github.com/PaddlePaddle/PaddleDetection/tree/develop/configs/mask_rcnn) | 动态图 | 支持 | 支持 | 支持 |
24+
| Mask R-CNN + FPN | 目标检测 | [模型链接](https://github.com/PaddlePaddle/PaddleDetection/tree/develop/configs/mask_rcnn) | 动态图 | 支持 | 支持 | 支持 |
25+
26+
27+
## 图像分割
28+
29+
| 模型 | 领域 | 模型链接 | 编程范式 | 训练单机多卡支持 | 训练多机多卡支持 | 推理支持 |
30+
| ----------------- | -------- | ------------------------------------------------------------ | ------------- | -------------- | -------------- | -------------- |
31+
| DeepLabV3+ | 图像分割 | [模型链接](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/configs/deeplabv3p) | 动态图 | 支持 | 不支持 | 支持 |
32+
| U-Net | 图像分割 | [模型链接](https://github.com/PaddlePaddle/PaddleSeg/tree/develop/configs/unet) | 动态图 | 支持 | 不支持 | 支持 |
33+
34+
## 自然语言处理
35+
36+
| 模型 | 领域 | 模型链接 | 编程范式 | 训练单机多卡支持 | 训练多机多卡支持 | 推理支持 |
37+
| ----------------- | -------- | ------------------------------------------------------------ | ------------- | -------------- | -------------- | -------------- |
38+
| BERT | NLP | [模型链接](https://github.com/PaddlePaddle/PaddleNLP/tree/develop/examples/language_model/bert) | 动态图 | 支持 | 支持 | 支持 |
39+
| Transformer | NLP | [模型链接](https://github.com/PaddlePaddle/PaddleNLP/tree/develop/examples/machine_translation/transformer) | 动态图 | 支持 | 支持 | 支持 |
40+
| Bi-LSTM | NLP | [模型链接](https://github.com/PaddlePaddle/PaddleNLP/tree/develop/examples/text_classification/rnn) | 动态图 | 支持 | 支持 | 支持 |
41+
42+
43+
## 字符识别
44+
45+
| 模型 | 领域 | 模型链接 | 编程范式 | 训练单机多卡支持 | 训练多机多卡支持 | 推理支持 |
46+
| ----------------- | -------- | ------------------------------------------------------------ | ------------- | -------------- | -------------- | -------------- |
47+
| OCR-DB | 文本检测 | [模型链接](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/detection.md) | 动态图 | 支持 | 支持 | 支持 |
48+
| CRNN-CTC | 文本识别 | [模型链接](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/recognition.md) | 动态图 | 支持 | 支持 | 支持 |
49+
| OCR-Clas | 角度分类 | [模型链接](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/angle_class.md) | 动态图 | 支持 | 支持 | 支持 |
50+
| OCR-E2E | 字符识别 | [模型链接](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/pgnet.md) | 动态图 | 支持 | 支持 | 支持 |
51+
52+
53+
## 模型套件
54+
55+
模型放置在飞桨模型套件中，各领域套件是 github.com/PaddlePaddle 下的独立 repo，git clone 下载即可获取所需的模型文件：
56+
57+
| 领域 | 套件名称 | 分支/版本 |
58+
| ----------- | --------------- | ---------------- |
59+
| 图像分类 | PaddleClas | develop |
60+
| 目标检测 | PaddleDetection | develop |
61+
| 图像分割 | PaddleSeg | develop |
62+
| 自然语言处理 | PaddleNLP | develop |
63+
| 字符识别 | PaddleOCR | develop |

‎docs/guides/hardware_support/mlu_docs/train_example_cn.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# 飞桨框架 MLU 版训练示例
2+
3+
使用寒武纪 MLU370 进行训练与使用 Intel CPU/Nvidia GPU 训练相同，当前 Paddle MLU 版本完全兼容 Paddle CUDA 版本的 API，直接使用原有的 GPU 训练命令和参数即可。
4+
5+
#### ResNet50 训练示例
6+
7+
**第一步**：安装 MLU 支持的 Paddlepaddle
8+
9+
Paddle MLU 版的 Python 预测库请参考 [飞桨框架 MLU 版安装说明](./paddle_install_cn.html) 进行安装或编译。
10+
11+
12+
**第二步**：下载 ResNet50 代码，并准备 ImageNet1k 数据集
13+
14+
```bash
15+
cd path_to_clone_PaddleClas
16+
git clone -b mlu-int32-label https://github.com/ShawnNew/PaddleClas
17+
```
18+
也可以访问 PaddleClas 的 [GitHub Repo](https://github.com/PaddlePaddle/PaddleClas) 直接下载源码。请根据[数据说明](https://github.com/PaddlePaddle/PaddleClas/blob/release/2.4/docs/zh_CN/data_preparation/classification_dataset.md)文档准备 ImageNet1k 数据集。
19+
20+
**第三步**：运行训练
21+
22+
使用飞浆 PaddleXXX 套件运行 MLU 可以通过设置 Global.device 参数为 mlu 来指定设备，其他模型也可以参考该使用方式
23+
24+
```bash
25+
export MLU_VISIBLE_DEVICES=0,1,2,3
26+
27+
cd PaddleClas/
28+
python3.7 -m paddle.distributed.launch --mlus="0,1,2,3" tools/train.py \
29+
-c ./ppcls/configs/ImageNet/ResNet/ResNet50.yaml \
30+
-o Global.device=mlu
31+
```

0 commit comments

Comments
 (0)