Skip to content

Commit 94f7b2b

Browse files
authored
fix docker relative doc when build from source (#6469)
1 parent 177944d commit 94f7b2b

File tree

5 files changed

+106
-46
lines changed

5 files changed

+106
-46
lines changed

docs/install/compile/linux-compile-by-make.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Docker 环境中已预装好编译 Paddle 需要的各种依赖,相较本机
3737

3838
- 在本地主机上[安装 Docker](https://docs.docker.com/engine/install/)
3939

40-
- 如需在 Linux 开启 GPU 支持,请[安装 nvidia-docker](https://github.com/NVIDIA/nvidia-docker)
40+
- 如需在 Linux 开启 GPU 支持,请[安装 NVIDIA Container Toolkit
41+
](https://github.com/NVIDIA/nvidia-container-toolkit)
4142

4243
请您按照以下步骤安装:
4344

@@ -64,29 +65,30 @@ cd Paddle
6465
6566
* GPU 版的 PaddlePaddle:
6667
```
67-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
68+
docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
6869
```
6970
70-
如果您的机器不在中国大陆地区,可以直接从 DockerHub 拉取镜像:
71+
如果您的机器不在中国大陆地区,可以直接从 [DockerHub 中的 paddle 镜像仓库](https://hub.docker.com/r/paddlepaddle/paddle/tags) 拉取镜像:
7172
7273
* CPU 版的 PaddlePaddle:
7374
```
7475
docker pull paddlepaddle/paddle:latest-dev
7576
```
7677
77-
* GPU 版的 PaddlePaddle:
78+
* GPU 版的 PaddlePaddle(**建议使用较新的镜像,并确保已经成功安装 NVIDIA Container Toolkit**)
7879
```
79-
nvidia-docker pull paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
80+
docker pull paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
8081
```
8182
82-
上例中,`latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82` 仅作示意用,表示安装 GPU 版的镜像。如果您还想安装其他 cuda/cudnn 版本的镜像,可以将其替换成`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`等
83+
上例中,`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2` 仅作示意用,表示安装 GPU 版的镜像。如果您还想安装其他 cuda/cudnn 版本的镜像,可以将其替换成其他版本(建议拉取最新的 GPU 版本)
8384
您可以访问[DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/)获取与您机器适配的镜像。
8485
8586
8687
#### 4. 创建并进入已配置好编译环境的 Docker 容器:
8788
8889
* 编译 CPU 版本的 PaddlePaddle:
8990
91+
用从百度拉取的镜像创建容器:
9092
```
9193
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash
9294
```
@@ -99,11 +101,16 @@ cd Paddle
99101
100102
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev`:使用名为`registry.baidubce.com/paddlepaddle/paddle:latest-dev`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
101103
104+
若使用的是从 DockerHub 拉取的镜像创建容器,则修改镜像名即可:
105+
```
106+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev /bin/bash
107+
```
102108
103109
* 编译 GPU 版本的 PaddlePaddle:
104110
111+
用从百度拉取的镜像创建容器
105112
```
106-
nvidia-docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82 /bin/bash
113+
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
107114
```
108115
109116
- `--name paddle-test`:为您创建的 Docker 容器命名为 paddle-test;
@@ -112,12 +119,18 @@ cd Paddle
112119
113120
- `-it`: 与宿主机保持交互状态;
114121
115-
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82`:使用名为`registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
122+
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`:使用名为`registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
116123
124+
若使用的是从 DockerHub 拉取的镜像创建容器,则修改镜像名即可:
125+
```
126+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
127+
```
117128
118129
注意:
119130
请确保至少为 docker 分配 4g 以上的内存,否则编译过程可能因内存不足导致失败。
120131
132+
**使用 GPU 版本镜像时,请确保成功安装 NVIDIA Container Toolkit ,否则无法在镜像中启用 GPU ,并且建议选择最新的 CPU 或者 GPU 镜像,否则可能会由于代码迭代较快,出现编译相关问题。**
133+
121134
#### 5. 进入 Docker 后进入 paddle 目录下:
122135
123136
```

docs/install/compile/linux-compile-by-make_en.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Compiling PaddlePaddle with Docker,you need:
3737

3838
- On the local host [Install Docker](https://docs.docker.com/engine/install/)
3939

40-
- To enable GPU support on Linux, please [Install nvidia-docker](https://github.com/NVIDIA/nvidia-docker)
40+
- To enable GPU support on Linux, please [Install NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-container-toolkit)
4141

4242
Please follow the steps below to install:
4343

@@ -63,7 +63,7 @@ For domestic users, when downloading docker is slow due to network problems, you
6363
6464
* GPU version of PaddlePaddle:
6565
```
66-
docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
66+
docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
6767
```
6868
6969
If your machine is not in mainland China, you can pull the image directly from DockerHub:
@@ -75,7 +75,7 @@ If your machine is not in mainland China, you can pull the image directly from D
7575
7676
* GPU version of PaddlePaddle:
7777
```
78-
docker pull paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
78+
docker pull paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
7979
```
8080
8181
In the above example, `latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82` is only for illustration, indicating that the GPU version of the image is installed. If you want to install another `cuda/cudnn` version of the image, you can replace it with `latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2` etc.
@@ -88,6 +88,7 @@ You can see [DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/) to g
8888
8989
* Compile CPU version of PaddlePaddle:
9090
91+
Using the image pulled from Baidu.
9192
```
9293
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash
9394
```
@@ -102,12 +103,17 @@ You can see [DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/) to g
102103
103104
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev`: use the image named `registry.baidubce.com/paddlepaddle/paddle:latest-dev` to create Docker container, /bin/bash start the /bin/bash command after entering the container.
104105
106+
If you are using the image pulled from DockerHub, just modify the image name.
107+
```
108+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev /bin/bash
109+
```
105110
106111
107112
* Compile GPU version of PaddlePaddle:
108113
114+
Using the image pulled from Baidu.
109115
```
110-
nvidia-docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82 /bin/bash
116+
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
111117
```
112118
113119
- `--name paddle-test`: names the Docker container you created as paddle-test;
@@ -119,12 +125,18 @@ You can see [DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/) to g
119125
120126
- `-it`: keeps interaction with the host;
121127
122-
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82`: use the image named `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82` to create Docker container, /bin/bash start the /bin/bash command after entering the container.
128+
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`: use the image named `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2` to create Docker container, /bin/bash start the /bin/bash command after entering the container.
123129
130+
If you are using the image pulled from DockerHub, just modify the image name.
131+
```
132+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
133+
```
124134
125135
Note:
126136
Please make sure to allocate at least 4g of memory for docker, otherwise the compilation process may fail due to insufficient memory.
127137
138+
**When using GPU version of image, please make sure the NVIDIA Container Toolkit is successfully installed, or GPU can not be used in docker container. And the latest version of image is recommended, or some compiling error may occur.**
139+
128140
#### 5. After entering Docker, go to the paddle directory:
129141
```
130142
cd /paddle

docs/install/compile/linux-compile-by-ninja.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Docker 环境中已预装好编译 Paddle 需要的各种依赖,相较本机
3737

3838
- 在本地主机上[安装 Docker](https://docs.docker.com/engine/install/)
3939

40-
- 如需在 Linux 开启 GPU 支持,请[安装 nvidia-docker](https://github.com/NVIDIA/nvidia-docker)
40+
- 如需在 Linux 开启 GPU 支持,请[安装 NVIDIA Container Toolkit
41+
](https://github.com/NVIDIA/nvidia-container-toolkit)
4142

4243
请您按照以下步骤安装:
4344

@@ -61,40 +62,75 @@ cd Paddle
6162
```
6263
docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev
6364
```
65+
6466
* GPU 版的 PaddlePaddle:
6567
```
66-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
68+
docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
6769
```
68-
如果您的机器不在中国大陆地区,可以直接从 DockerHub 拉取镜像:
70+
71+
如果您的机器不在中国大陆地区,可以直接从 [DockerHub 中的 paddle 镜像仓库](https://hub.docker.com/r/paddlepaddle/paddle/tags) 拉取镜像:
72+
6973
* CPU 版的 PaddlePaddle:
7074
```
7175
docker pull paddlepaddle/paddle:latest-dev
7276
```
73-
* GPU 版的 PaddlePaddle:
77+
78+
* GPU 版的 PaddlePaddle(**建议使用较新的镜像,并确保已经成功安装 NVIDIA Container Toolkit**):
7479
```
75-
nvidia-docker pull paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82
80+
docker pull paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2
7681
```
77-
上例中,`latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82` 仅作示意用,表示安装 GPU 版的镜像。如果您还想安装其他 cuda/cudnn 版本的镜像,可以将其替换成`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`等。
82+
83+
上例中,`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2` 仅作示意用,表示安装 GPU 版的镜像。如果您还想安装其他 cuda/cudnn 版本的镜像,可以将其替换成其他版本(建议拉取最新的 GPU 版本)。
7884
您可以访问[DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/)获取与您机器适配的镜像。
85+
86+
7987
#### 4. 创建并进入已配置好编译环境的 Docker 容器:
88+
8089
* 编译 CPU 版本的 PaddlePaddle:
90+
91+
用从百度拉取的镜像创建容器
8192
```
8293
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash
8394
```
95+
8496
- `--name paddle-test`:为您创建的 Docker 容器命名为 paddle-test;
97+
8598
- `-v $PWD:/paddle`: 将当前目录挂载到 Docker 容器中的/paddle 目录下(Linux 中 PWD 变量会展开为当前路径的[绝对路径](https://baike.baidu.com/item/绝对路径/481185));
99+
86100
- `-it`: 与宿主机保持交互状态;
101+
87102
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev`:使用名为`registry.baidubce.com/paddlepaddle/paddle:latest-dev`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
103+
104+
若使用的是从 DockerHub 拉取的镜像创建容器,则修改镜像名即可:
105+
```
106+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev /bin/bash
107+
```
108+
88109
* 编译 GPU 版本的 PaddlePaddle:
110+
111+
用从百度拉取的镜像创建容器
89112
```
90-
nvidia-docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82 /bin/bash
113+
docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
91114
```
115+
92116
- `--name paddle-test`:为您创建的 Docker 容器命名为 paddle-test;
117+
93118
- `-v $PWD:/paddle`: 将当前目录挂载到 Docker 容器中的/paddle 目录下(Linux 中 PWD 变量会展开为当前路径的[绝对路径](https://baike.baidu.com/item/绝对路径/481185));
119+
94120
- `-it`: 与宿主机保持交互状态;
95-
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82`:使用名为`registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda11.2-cudnn8.2-trt8.0-gcc82`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
121+
122+
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`:使用名为`registry.baidubce.com/paddlepaddle/paddle`, tag 为`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
123+
124+
若使用的是从 DockerHub 拉取的镜像创建容器,则修改镜像名即可:
125+
```
126+
docker run --name paddle-test -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
127+
```
128+
96129
注意:
97130
请确保至少为 docker 分配 4g 以上的内存,否则编译过程可能因内存不足导致失败。
131+
132+
**使用 GPU 版本镜像时,请确保成功安装 NVIDIA Container Toolkit ,否则无法在镜像中启用 GPU ,并且建议选择最新的 CPU 或者 GPU 镜像,否则可能会由于代码迭代较快,出现编译相关问题**
133+
98134
#### 5. 进入 Docker 后进入 paddle 目录下:
99135
```
100136
cd /paddle

docs/install/docker/linux-docker.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
- 在本地主机上[安装 Docker](https://docs.docker.com/engine/install/)
1111

12-
- 如需在 Linux 开启 GPU 支持,请[安装 nvidia-docker](https://github.com/NVIDIA/nvidia-docker)
12+
- 如需在 Linux 开启 GPU 支持,请[安装 NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-container-toolkit)
1313

1414
- 镜像中 Python 版本为 3.10
1515

@@ -29,15 +29,15 @@
2929
docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-jupyter
3030
```
3131
32-
* GPU 版的 PaddlePaddle:
32+
* GPU 版的 PaddlePaddle(**建议拉取最新版本镜像,并确保已经成功安装 NVIDIA Container Toolkit**)
3333
```
34-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.2-cudnn8.2-trt8.0
34+
docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.2-cudnn8.2-trt8.0
3535
```
3636
```
37-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.7-cudnn8.4-trt8.4
37+
docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.7-cudnn8.4-trt8.4
3838
```
3939
```
40-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6
40+
docker pull registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6
4141
```
4242
4343
如果您的机器不在中国大陆地区,可以直接从 DockerHub 拉取镜像:
@@ -52,15 +52,15 @@
5252
docker pull paddlepaddle/paddle:2.6.0-jupyter
5353
```
5454
55-
* GPU 版的 PaddlePaddle:
55+
* GPU 版的 PaddlePaddle(**建议拉取最新版本镜像,并确保已经成功安装 NVIDIA Container Toolkit**)
5656
```
57-
nvidia-docker pull paddlepaddle/paddle:2.6.0-gpu-cuda11.2-cudnn8.2-trt8.0
57+
docker pull paddlepaddle/paddle:2.6.0-gpu-cuda11.2-cudnn8.2-trt8.0
5858
```
5959
```
60-
nvidia-docker pull paddlepaddle/paddle:2.6.0-gpu-cuda11.7-cudnn8.4-trt8.4
60+
docker pull paddlepaddle/paddle:2.6.0-gpu-cuda11.7-cudnn8.4-trt8.4
6161
```
6262
```
63-
nvidia-docker pull paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6
63+
docker pull paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6
6464
```
6565
6666
您还可以访问[DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/)获取更多镜像。
@@ -115,18 +115,17 @@
115115
* 使用 GPU 版本的 PaddlePaddle:
116116
117117
```
118-
nvidia-docker run --name paddle_docker -it -v $PWD:/paddle registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6
118+
docker run --name paddle_docker -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2 /bin/bash
119119
```
120120
121121
- `--name paddle_docker`:设定 Docker 的名称,`paddle_docker` 是自己设置的名称;
122122
123123
124-
- `-it`:参数说明容器已和本机交互式运行;
125-
124+
- `-v $PWD:/paddle`: 将当前目录挂载到 Docker 容器中的/paddle 目录下(Linux 中 PWD 变量会展开为当前路径的[绝对路径](https://baike.baidu.com/item/绝对路径/481185));
126125
127-
- `-v $PWD:/paddle`:指定将当前路径(PWD 变量会展开为当前路径的绝对路径)挂载到容器内部的 /paddle 目录;
126+
- `-it`: 与宿主机保持交互状态;
128127
129-
- `registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda12.0-cudnn8.9-trt8.6`:指定需要使用的 image 名称,如果您希望使用 CUDA 11.2 或 CUDA 11.7 的镜像,也可以将其替换成`registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.2-cudnn8.2-trt8.0` 或 `registry.baidubce.com/paddlepaddle/paddle:2.6.0-gpu-cuda11.7-cudnn8.4-trt8.4`。您可以通过`docker images`命令查看镜像。/bin/bash 是在 Docker 中要执行的命令
128+
- `registry.baidubce.com/paddlepaddle/paddle:latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`:使用名为`registry.baidubce.com/paddlepaddle/paddle`, tag 为`latest-dev-cuda12.0-cudnn8.9-trt8.6-gcc12.2`的镜像创建 Docker 容器,/bin/bash 进入容器后启动/bin/bash 命令。
130129
131130
132131

0 commit comments

Comments
 (0)