-[2.(Recommended) Prepare a docker environment](#2)
-[2.(Recommended) Prepare a docker environment](#2)
-[3. Install PaddlePaddle using pip](#3)
-[3. Install PaddlePaddle using pip](#3)
-[4. Verify installation](#4)
-[4. Verify installation](#4)
At present, **PaddleClas** requires **PaddlePaddle** version `>=2.0`. Docker is recomended to run Paddleclas, for more detailed information about docker and nvidia-docker, you can refer to the [tutorial](https://docs.docker.com/get-started/). If you do not want to use docker, you can skip section [2. (Recommended) Prepare a docker environment](#2), and go into section [3. Install PaddlePaddle using pip](#3).
Docker is recomended to run Paddleclas, for more detailed information about docker and nvidia-docker, you can refer to the [tutorial](https://docs.docker.com/get-started/). If you do not want to use docker, you can skip section [1.1.1 (Recommended) Install PaddlePaddle by docker](#1.1.1), and go into section [1.1.2 Install PaddlePaddle by pip](#1.1.2).
<aname="1"></a>
<aname="1"></a>
## 1. Environment requirements
## 1. Prepara Environment
<aname="1.1"></a>
## 1.1 Install PaddlePaddle
- python 3.x
- python 3.x
- cuda >= 10.1 (necessary if paddlepaddle-gpu is used)
- cuda >= 10.2 (necessary if paddlepaddle-gpu is used)
- cudnn >= 7.6.4 (necessary if paddlepaddle-gpu is used)
- cudnn >= 7.6.4 (necessary if paddlepaddle-gpu is used)
- nccl >= 2.1.2 (necessary distributed training/eval is used)
- nccl >= 2.1.2 (necessary distributed training/eval is used)
- gcc >= 8.2
- gcc >= 8.2
**Recomends**:
**Recomends**:
* When CUDA version is 10.1, the driver version `>= 418.39`;
* When CUDA version is 10.2, the driver version `>= 440.33`;
* When CUDA version is 10.2, the driver version `>= 440.33`;
* For more CUDA versions and specific driver versions, please refer to [link](https://docs.nvidia.com/deploy/cuda-compatibility/index.html).
* For more CUDA versions and specific driver versions, please refer to [link](https://docs.nvidia.com/deploy/cuda-compatibility/index.html).
<aname="1.1.1"></a>
<aname="2"></a>
## 1.1.1 (Recommended) Install PaddlePaddle by Docker
## 2. (Recommended) Prepare a docker environment
* Switch to the working directory
* Switch to the working directory
...
@@ -41,10 +53,10 @@ The following commands will create a docker container named ppcls and map the cu
...
@@ -41,10 +53,10 @@ The following commands will create a docker container named ppcls and map the cu
* If you have already installed CPU version of PaddlePaddle and want to use GPU version now, you should uninstall CPU version of PaddlePaddle and then install GPU version to avoid package confusion.
* If you have already installed CPU version of PaddlePaddle and want to use GPU version now, you should uninstall CPU version of PaddlePaddle and then install GPU version to avoid package confusion.
* You can also compile PaddlePaddle from source code, please refer to [PaddlePaddle Installation tutorial](http://www.paddlepaddle.org.cn/install/quick) to more compilation options.
* You can also compile PaddlePaddle from source code, please refer to [PaddlePaddle Installation tutorial](http://www.paddlepaddle.org.cn/install/quick) to more compilation options.
<a name="4"></a>
<a name="1.1.3"></a>
## 4. Verify Installation
## 1.1.3 Check Installation
```python
```python
import paddle
import paddle
...
@@ -98,3 +110,35 @@ Note:
...
@@ -98,3 +110,35 @@ Note:
* Make sure the compiled source code is later than PaddlePaddle2.0.
* Make sure the compiled source code is later than PaddlePaddle2.0.
* Indicate `WITH_DISTRIBUTE=ON` when compiling, Please refer to [Instruction](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/install/Tables.html#id3) for more details.
* Indicate `WITH_DISTRIBUTE=ON` when compiling, Please refer to [Instruction](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/install/Tables.html#id3) for more details.
* When running in docker, in order to ensure that the container has enough shared memory for dataloader acceleration of Paddle, please set the parameter `--shm-size=8g` at creating a docker container, if conditions permit, you can set it to a larger value.
* When running in docker, in order to ensure that the container has enough shared memory for dataloader acceleration of Paddle, please set the parameter `--shm-size=8g` at creating a docker container, if conditions permit, you can set it to a larger value.
* Please build and install locally if you need to use the develop branch of PaddleClas to experience the latest functions, or need to redevelop based on PaddleClas. The command is as follows:
* Please build and install locally if you need to use the develop branch of PaddleClas to experience the latest functions, or need to redevelop based on PaddleClas. The command is as follows:
