Skip to content

P
PaddleClas

PaddlePaddle / PaddleClas
大约 1 年 前同步成功

通知 115
Star 4999
Fork 1114
P
PaddleClas
未验证 提交 e148cd23 编写于 作者: W Wei Shengyu 提交者： GitHub
浏览文件
操作

Merge pull request #2000 from weisy11/doc_0608 

merge 2 install doc
上级 b01a79ab d83c526e
显示空白变更内容
内联 并排
Showing with 81 addition and 117 deletion
docs/zh_CN/PULC/PULC_person_exists.md
浏览文件 @ e148cd23
...@@ -117,7 +117,7 @@ print(next(result)) ...@@ -117,7 +117,7 @@ print(next(result))
### 3.1 环境配置 ### 3.1 环境配置
* 安装：请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 * 安装：请先参考文档[环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。
<a name="3.2"></a> <a name="3.2"></a>
......
docs/zh_CN/PULC/PULC_traffic_sign.md
浏览文件 @ e148cd23
...@@ -73,7 +73,7 @@ ...@@ -73,7 +73,7 @@
### 3.1 环境配置 ### 3.1 环境配置
* 安装：请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 * 安装：请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。
<a name="3.2"></a> <a name="3.2"></a>
......
docs/zh_CN/PULC/PULC_vehicle_attr.md
浏览文件 @ e148cd23
...@@ -75,7 +75,7 @@ ...@@ -75,7 +75,7 @@
### 3.1 环境配置 ### 3.1 环境配置
* 安装：请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 * 安装：请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。
<a name="3.2"></a> <a name="3.2"></a>
......
docs/zh_CN/inference_deployment/export_model.md
浏览文件 @ e148cd23
...@@ -17,7 +17,7 @@ PaddlePaddle 支持导出 inference 模型用于部署推理场景，相比于 ...@@ -17,7 +17,7 @@ PaddlePaddle 支持导出 inference 模型用于部署推理场景，相比于
<a name="1"></a> <a name="1"></a>
## 1. 环境准备 ## 1. 环境准备
首先请参考文档[安装 PaddlePaddle](../installation/install_paddle.md)和文档[安装 PaddleClas](../installation/install_paddleclas.md)配置运行环境。 首先请参考文档文档[环境准备](../installation/install_paddleclas.md)配置运行环境。
<a name="2"></a> <a name="2"></a>
## 2. 分类模型导出 ## 2. 分类模型导出
......
docs/zh_CN/inference_deployment/python_deploy.md
浏览文件 @ e148cd23
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
--- ---
首先请参考文档[安装 PaddlePaddle](../installation/install_paddle.md)和文档[安装 PaddleClas](../installation/install_paddleclas.md)配置运行环境。 首先请参考文档[环境准备](../installation/install_paddleclas.md)配置运行环境。
## 目录 ## 目录
......
docs/zh_CN/installation/install_paddle.md 已删除 100644 → 0
浏览文件 @ b01a79ab
# 安装 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) 部分开始。
<a name='1'></a>
## 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)。
<a name="2"></a>
## 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
```
<a name="3"></a>
## 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) 中的说明进行操作。
<a name='4'></a>
## 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`，条件允许的话可以设置为更大的值。
docs/zh_CN/installation/install_paddleclas.md
浏览文件 @ e148cd23
# 安装 PaddleClas # 环境准备
--- ---
## 目录 ## 目录
* [1. 克隆 PaddleClas](#1) - [1. 安装 PaddlePaddle](#1)
* [2. 安装 Python 依赖库](#2) - [1.1 使用Paddle官方镜像](#1.1)
- [1.2 在现有环境中安装paddle](#1.2)
- [1.3 安装验证](#1.3)
- [2. 克隆 PaddleClas](#2)
- [3. 安装 Python 依赖库](#3)
<a name='1'></a> <a name='1'></a>
### 1.安装PaddlePaddle
目前，**PaddleClas** 要求 **PaddlePaddle** 版本 `>=2.3`。
建议使用Paddle官方提供的 Docker 镜像运行 PaddleClas，有关 Docker、nvidia-docker 的相关使用教程可以参考[链接](https://www.runoob.com/Docker/Docker-tutorial.html)。
## 1. 克隆 PaddleClas <a name='1.1'></a>
#### 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
```
<a name='1.2'></a>
#### 1.2 在现有环境中安装paddle
您也可以用pip或conda直接安装paddle，详情请参考官方文档中的[快速安装](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/docker/linux-docker.html)部分。
<a name='1.3'></a>
#### 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`，条件允许的话可以设置为更大的值。
<a name='2'></a>
### 2. 克隆 PaddleClas
从 GitHub 下载： 从 GitHub 下载：
```shell ```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 下载，命令如下： 如果访问 GitHub 网速较慢，可以从 Gitee 下载，命令如下：
```shell ```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
``` ```
<a name='2'></a> <a name='3'></a>
## 2. 安装 Python 依赖库 ### 3. 安装 Python 依赖库
PaddleClas 的 Python 依赖库在 `requirements.txt` 中给出，可通过如下命令安装： PaddleClas 的 Python 依赖库在 `requirements.txt` 中给出，可通过如下命令安装：
......
docs/zh_CN/quick_start/quick_start_classification_new_user.md
浏览文件 @ e148cd23
...@@ -48,7 +48,7 @@ ...@@ -48,7 +48,7 @@
## 2. 环境安装与配置 ## 2. 环境安装与配置
具体安装步骤可详看[Paddle 安装文档](../installation/install_paddle.md)，[PaddleClas 安装文档](../installation/install_paddleclas.md)。 具体安装步骤可详看[环境准备](../installation/install_paddleclas.md)。
<a name='3'></a> <a name='3'></a>
......
docs/zh_CN/quick_start/quick_start_multilabel_classification.md
浏览文件 @ e148cd23
# 多标签分类 quick start # 多标签分类 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)。
## 目录 ## 目录
......
docs/zh_CN/quick_start/quick_start_recognition.md
浏览文件 @ e148cd23
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
## 1. 环境配置 ## 1. 环境配置
* 安装：请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 * 安装：请先参考文档 [环境准备](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。
* 进入 `deploy` 运行目录。本部分所有内容与命令均需要在 `deploy` 目录下运行，可以通过下面的命令进入 `deploy` 目录。 * 进入 `deploy` 运行目录。本部分所有内容与命令均需要在 `deploy` 目录下运行，可以通过下面的命令进入 `deploy` 目录。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或