diff --git a/docs/zh_CN/PULC/PULC_person_exists.md b/docs/zh_CN/PULC/PULC_person_exists.md index 198e015cb93ceaf0c898060b680e315f13eaea2c..b77749dc56d97727702ff67750b3c36b4b9ddb25 100644 --- a/docs/zh_CN/PULC/PULC_person_exists.md +++ b/docs/zh_CN/PULC/PULC_person_exists.md @@ -74,7 +74,7 @@ ### 3.1 环境配置 -* 安装:请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 +* 安装:请先参考文档[环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 diff --git a/docs/zh_CN/PULC/PULC_traffic_sign.md b/docs/zh_CN/PULC/PULC_traffic_sign.md index 74a7d97ac1e8700cef08749d6a0a9f7820cd502f..c24bd8e0ac068dc009a2935ed5f4958ae9c9ebe9 100644 --- a/docs/zh_CN/PULC/PULC_traffic_sign.md +++ b/docs/zh_CN/PULC/PULC_traffic_sign.md @@ -73,7 +73,7 @@ ### 3.1 环境配置 -* 安装:请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 +* 安装:请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 diff --git a/docs/zh_CN/PULC/PULC_vehicle_attr.md b/docs/zh_CN/PULC/PULC_vehicle_attr.md index 80e038ac8babe673499320f0e9f4b0d94898ef1c..a345d3f7301c133a8f036c85b879b112d4eceb96 100644 --- a/docs/zh_CN/PULC/PULC_vehicle_attr.md +++ b/docs/zh_CN/PULC/PULC_vehicle_attr.md @@ -75,7 +75,7 @@ ### 3.1 环境配置 -* 安装:请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 +* 安装:请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 diff --git a/docs/zh_CN/inference_deployment/export_model.md b/docs/zh_CN/inference_deployment/export_model.md index 1d8decb2837c0f68f71a6b022b05e574ce3ef83b..5e7d204c5f3e9755d2c97428c040fe7c2aa328e2 100644 --- a/docs/zh_CN/inference_deployment/export_model.md +++ b/docs/zh_CN/inference_deployment/export_model.md @@ -17,7 +17,7 @@ PaddlePaddle 支持导出 inference 模型用于部署推理场景,相比于 ## 1. 环境准备 -首先请参考文档[安装 PaddlePaddle](../installation/install_paddle.md)和文档[安装 PaddleClas](../installation/install_paddleclas.md)配置运行环境。 +首先请参考文档文档[环境准备](../installation/install_paddleclas.md)配置运行环境。 ## 2. 分类模型导出 diff --git a/docs/zh_CN/inference_deployment/python_deploy.md b/docs/zh_CN/inference_deployment/python_deploy.md index 39843df12d17265fc586b160003e3361edb8a14a..c720ae520f45ec9550a82de46dc26d28b0670ec0 100644 --- a/docs/zh_CN/inference_deployment/python_deploy.md +++ b/docs/zh_CN/inference_deployment/python_deploy.md @@ -2,7 +2,7 @@ --- -首先请参考文档[安装 PaddlePaddle](../installation/install_paddle.md)和文档[安装 PaddleClas](../installation/install_paddleclas.md)配置运行环境。 +首先请参考文档[环境准备](../installation/install_paddleclas.md)配置运行环境。 ## 目录 diff --git a/docs/zh_CN/installation/install_paddle.md b/docs/zh_CN/installation/install_paddle.md deleted file mode 100644 index 995d28797c3078956af5571ef11506c2028481e4..0000000000000000000000000000000000000000 --- a/docs/zh_CN/installation/install_paddle.md +++ /dev/null @@ -1,101 +0,0 @@ -# 安装 PaddlePaddle - ---- -## 目录 - -- [1. 环境要求](#1) -- [2.(建议)使用 Docker 环境](#2) -- [3. 通过 pip 安装 PaddlePaddle](#3) -- [4. 验证安装](#4) - -目前,**PaddleClas** 要求 **PaddlePaddle** 版本 `>=2.0`。建议使用我们提供的 Docker 运行 PaddleClas,有关 Docker、nvidia-docker 的相关使用教程可以参考[链接](https://www.runoob.com/Docker/Docker-tutorial.html)。如果不使用 Docker,可以直接跳过 [2.(建议)使用 Docker 环境](#2) 部分内容,从 [3. 通过 pip 安装 PaddlePaddle](#3) 部分开始。 - - - -## 1. 环境要求 - -**版本要求**: -- python 3.x -- CUDA >= 10.1(如果使用 `paddlepaddle-gpu`) -- cuDNN >= 7.6.4(如果使用 `paddlepaddle-gpu`) -- nccl >= 2.1.2(如果使用分布式训练/评估) -- gcc >= 8.2 - -**建议**: -* 当 CUDA 版本为 10.1 时,显卡驱动版本 `>= 418.39`; -* 当 CUDA 版本为 10.2 时,显卡驱动版本 `>= 440.33`; -* 更多 CUDA 版本与要求的显卡驱动版本可以参考[链接](https://docs.nvidia.com/deploy/cuda-compatibility/index.html)。 - - - -## 2.(建议)使用 Docker 环境 - -* 切换到工作目录下 - -```shell -cd /home/Projects -``` - -* 创建 docker 容器 - -下述命令会创建一个名为 ppcls 的 Docker 容器,并将当前工作目录映射到容器内的 `/paddle` 目录。 - -```shell -# 对于 GPU 用户 -sudo nvidia-docker run --name ppcls -v $PWD:/paddle --shm-size=8G --network=host -it paddlepaddle/paddle:2.1.0-gpu-cuda10.2-cudnn7 /bin/bash - -# 对于 CPU 用户 -sudo docker run --name ppcls -v $PWD:/paddle --shm-size=8G --network=host -it paddlepaddle/paddle:2.1.0 /bin/bash -``` - -**注意**: -* 首次使用该镜像时,下述命令会自动下载该镜像文件,下载需要一定的时间,请耐心等待; -* 上述命令会创建一个名为 ppcls 的 Docker 容器,之后再次使用该容器时无需再次运行该命令; -* 参数 `--shm-size=8G` 将设置容器的共享内存为 8 G,如机器环境允许,建议将该参数设置较大,如 `64G`; -* 您也可以访问 [DockerHub](https://hub.Docker.com/r/paddlepaddle/paddle/tags/) 获取与您机器适配的镜像; -* 退出/进入 docker 容器: - * 在进入 Docker 容器后,可使用组合键 `Ctrl + P + Q` 退出当前容器,同时不关闭该容器; - * 如需再次进入容器,可使用下述命令: - - ```shell - sudo Docker exec -it ppcls /bin/bash - ``` - - - -## 3. 通过 pip 安装 PaddlePaddle - -可运行下面的命令,通过 pip 安装最新版本 PaddlePaddle: - -```bash -# 对于 CPU 用户 -pip install paddlepaddle --upgrade -i https://mirror.baidu.com/pypi/simple - -# 对于 GPU 用户 -pip install paddlepaddle-gpu --upgrade -i https://mirror.baidu.com/pypi/simple -``` - -**注意:** -* 如果先安装了 CPU 版本的 PaddlePaddle,之后想切换到 GPU 版本,那么需要使用 pip 先卸载 CPU 版本的 PaddlePaddle,再安装 GPU 版本的 PaddlePaddle,否则容易导致 PaddlePaddle 冲突。 -* 您也可以从源码编译安装 PaddlePaddle,请参照 [PaddlePaddle 安装文档](http://www.paddlepaddle.org.cn/install/quick) 中的说明进行操作。 - - -## 4. 验证安装 - -使用以下命令可以验证 PaddlePaddle 是否安装成功。 - -```python -import paddle -paddle.utils.run_check() -``` - -查看 PaddlePaddle 版本的命令如下: - -```bash -python -c "import paddle; print(paddle.__version__)" -``` - -**注意**: -- 从源码编译的 PaddlePaddle 版本号为 `0.0.0`,请确保使用 PaddlePaddle 2.0 及之后的源码进行编译; -- PaddleClas 基于 PaddlePaddle 高性能的分布式训练能力,若您从源码编译,请确保打开编译选项 `WITH_DISTRIBUTE=ON`。具体编译选项参考 [编译选项表](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/install/Tables.html#bianyixuanxiangbiao); -- 在 Docker 中运行时,为保证 Docker 容器有足够的共享内存用于 Paddle 的数据读取加速,在创建 Docker 容器时,请设置参数 `--shm-size=8g`,条件允许的话可以设置为更大的值。 diff --git a/docs/zh_CN/installation/install_paddleclas.md b/docs/zh_CN/installation/install_paddleclas.md index 0f70bf2364589dbe85bf09128fc034d9d250d22b..e02acc6fdae4f211c07232489d07b31bd187da1d 100644 --- a/docs/zh_CN/installation/install_paddleclas.md +++ b/docs/zh_CN/installation/install_paddleclas.md @@ -1,29 +1,94 @@ -# 安装 PaddleClas +# 环境准备 --- ## 目录 -* [1. 克隆 PaddleClas](#1) -* [2. 安装 Python 依赖库](#2) +- [1. 安装 PaddlePaddle](#1) + - [1.1 使用Paddle官方镜像](#1.1) + - [1.2 在现有环境中安装paddle](#1.2) + - [1.3 安装验证](#1.3) +- [2. 克隆 PaddleClas](#2) +- [3. 安装 Python 依赖库](#3) +### 1.安装PaddlePaddle +目前,**PaddleClas** 要求 **PaddlePaddle** 版本 `>=2.3`。 +建议使用Paddle官方提供的 Docker 镜像运行 PaddleClas,有关 Docker、nvidia-docker 的相关使用教程可以参考[链接](https://www.runoob.com/Docker/Docker-tutorial.html)。 -## 1. 克隆 PaddleClas + + +#### 1.1(建议)使用 Docker 环境 + +* 切换到工作目录下,例如工作目录为`/home/Projects`,则运行命令: + +```shell +cd /home/Projects +``` + +* 创建 docker 容器 + +下述命令会创建一个名为 ppcls 的 Docker 容器,并将当前工作目录映射到容器内的 `/paddle` 目录。 + +```shell +# 对于 GPU 用户 +sudo nvidia-docker run --name ppcls -v $PWD:/paddle --shm-size=8G --network=host -it registry.baidubce.com/paddlepaddle/paddle:2.3.0-gpu-cuda10.2-cudnn7 /bin/bash + +# 对于 CPU 用户 +sudo docker run --name ppcls -v $PWD:/paddle --shm-size=8G --network=host -it paddlepaddle/paddle:2.3.0-gpu-cuda10.2-cudnn7 /bin/bash +``` + +**注意**: +* 首次使用该镜像时,下述命令会自动下载该镜像文件,下载需要一定的时间,请耐心等待; +* 上述命令会创建一个名为 ppcls 的 Docker 容器,之后再次使用该容器时无需再次运行该命令; +* 参数 `--shm-size=8G` 将设置容器的共享内存为 8 G,如机器环境允许,建议将该参数设置较大,如 `64G`; +* 您也可以访问 [DockerHub](https://hub.Docker.com/r/paddlepaddle/paddle/tags/) ,手动选择需要的镜像; +* 退出/进入 docker 容器: + * 在进入 Docker 容器后,可使用组合键 `Ctrl + P + Q` 退出当前容器,同时不关闭该容器; + * 如需再次进入容器,可使用下述命令: + + ```shell + sudo Docker exec -it ppcls /bin/bash + ``` + +#### 1.2 在现有环境中安装paddle +您也可以用pip或conda直接安装paddle,详情请参考官方文档中的[快速安装](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/docker/linux-docker.html)部分。 + +#### 1.3 安装验证 +使用以下命令可以验证 PaddlePaddle 是否安装成功。 +```python +import paddle +paddle.utils.run_check() +``` +查看 PaddlePaddle 版本的命令如下: + +```bash +python -c "import paddle; print(paddle.__version__)" +``` + +**注意**: +- 从源码编译的 PaddlePaddle 版本号为 `0.0.0`,请确保使用 PaddlePaddle 2.3 及之后的源码进行编译; +- PaddleClas 基于 PaddlePaddle 高性能的分布式训练能力,若您从源码编译,请确保打开编译选项 `WITH_DISTRIBUTE=ON`。具体编译选项参考 [编译选项表](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/install/Tables.html#bianyixuanxiangbiao); +- 在 Docker 中运行时,为保证 Docker 容器有足够的共享内存用于 Paddle 的数据读取加速,在创建 Docker 容器时,请设置参数 `--shm-size=8g`,条件允许的话可以设置为更大的值。 + + + + +### 2. 克隆 PaddleClas 从 GitHub 下载: ```shell -git clone https://github.com/PaddlePaddle/PaddleClas.git -b release/2.3 +git clone https://github.com/PaddlePaddle/PaddleClas.git -b release/2.4 ``` 如果访问 GitHub 网速较慢,可以从 Gitee 下载,命令如下: ```shell -git clone https://gitee.com/paddlepaddle/PaddleClas.git -b release/2.3 +git clone https://gitee.com/paddlepaddle/PaddleClas.git -b release/2.4 ``` - + -## 2. 安装 Python 依赖库 +### 3. 安装 Python 依赖库 PaddleClas 的 Python 依赖库在 `requirements.txt` 中给出,可通过如下命令安装: diff --git a/docs/zh_CN/quick_start/quick_start_classification_new_user.md b/docs/zh_CN/quick_start/quick_start_classification_new_user.md index 905f62d4dfc68a2bea61c87e7ef3867051d891fc..fdc61193c88b4b8b522842c7685bcdcf315dc4b5 100644 --- a/docs/zh_CN/quick_start/quick_start_classification_new_user.md +++ b/docs/zh_CN/quick_start/quick_start_classification_new_user.md @@ -48,7 +48,7 @@ ## 2. 环境安装与配置 -具体安装步骤可详看[Paddle 安装文档](../installation/install_paddle.md),[PaddleClas 安装文档](../installation/install_paddleclas.md)。 +具体安装步骤可详看[环境准备](../installation/install_paddleclas.md)。 diff --git a/docs/zh_CN/quick_start/quick_start_multilabel_classification.md b/docs/zh_CN/quick_start/quick_start_multilabel_classification.md index 888a61582078c009865317a4cb1b067264aa4082..ea6e691c1ef51fb1371a5ff747c4cfc4fe72a79d 100644 --- a/docs/zh_CN/quick_start/quick_start_multilabel_classification.md +++ b/docs/zh_CN/quick_start/quick_start_multilabel_classification.md @@ -1,6 +1,6 @@ # 多标签分类 quick start -基于 [NUS-WIDE-SCENE](https://lms.comp.nus.edu.sg/wp-content/uploads/2019/research/nuswide/NUS-WIDE.html) 数据集,体验多标签分类的训练、评估、预测的过程,该数据集是 NUS-WIDE 数据集的一个子集。请首先安装 PaddlePaddle 和 PaddleClas,具体安装步骤可详看 [Paddle 安装文档](../installation/install_paddle.md),[PaddleClas 安装文档](../installation/install_paddleclas.md)。 +基于 [NUS-WIDE-SCENE](https://lms.comp.nus.edu.sg/wp-content/uploads/2019/research/nuswide/NUS-WIDE.html) 数据集,体验多标签分类的训练、评估、预测的过程,该数据集是 NUS-WIDE 数据集的一个子集。请首先安装 PaddlePaddle 和 PaddleClas,具体安装步骤可详看 [环境准备](../installation/install_paddleclas.md)。 ## 目录 diff --git a/docs/zh_CN/quick_start/quick_start_recognition.md b/docs/zh_CN/quick_start/quick_start_recognition.md index e2e6b169ea0101239b33612a379fc17207e7ffd3..38803ec9be510d3a4a96117fce3a1ccf537d3af9 100644 --- a/docs/zh_CN/quick_start/quick_start_recognition.md +++ b/docs/zh_CN/quick_start/quick_start_recognition.md @@ -22,7 +22,7 @@ ## 1. 环境配置 -* 安装:请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 +* 安装:请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 * 进入 `deploy` 运行目录。本部分所有内容与命令均需要在 `deploy` 目录下运行,可以通过下面的命令进入 `deploy` 目录。