# 环境准备与安装

使用 PaddleX 前，需要进行环境准备，安装依赖项，主要包括安装飞桨 PaddlePaddle 框架、获取 PaddleX 源码并安装依赖。

## 1. 安装飞桨 PaddlePaddle

### 1.1 安装

#### 【推荐】使用 Docker 安装

参考下述命令，使用飞桨官方 Docker 镜像，创建一个名为 `paddlx` 的容器，并将当前工作目录映射到容器内的 `/paddle` 目录。

```shell
# 对于 GPU 用户
sudo nvidia-docker run --name paddlx -v $PWD:/paddle --shm-size=8G --network=host -it registry.baidubce.com/paddlepaddle/paddle:2.6.1-gpu-cuda12.0-cudnn8.9-trt8.6 /bin/bash

# 对于 CPU 用户
sudo docker run --name paddlx -v $PWD:/paddle --shm-size=8G --network=host -it registry.baidubce.com/paddlepaddle/paddle:2.6.1 /bin/bash
```

更多飞桨官方 docker 镜像请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/docker/linux-docker.html)。

**注意**：
* 首次使用该镜像时，下述命令会自动下载该镜像文件，下载需要一定的时间，请耐心等待；
* 请使用 **2.5.2** 及更高版本的 PaddlePaddle；
* 上述命令会创建一个名为 paddlx 的 Docker 容器，之后再次使用该容器时无需再次运行该命令；
* 参数 `--shm-size=8G` 将设置容器的共享内存为 8G，如机器环境允许，建议将该参数设置较大，如 `64G`；

#### 使用 Pip 或 Conda 安装

参考下述命令，用 pip 或 conda 在当前环境中安装飞桨 PaddlePaddle。

```bash
# pip
python -m pip install paddlepaddle-gpu==2.6.1.post120 -f https://www.paddlepaddle.org.cn/whl/linux/mkl/avx/stable.html

pip install paddlepaddle==2.6.1 -f https://www.paddlepaddle.org.cn/whl/linux/mkl/avx/stable.html

# conda
conda install paddlepaddle==2.6.1 --channel https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud/Paddle/
```

更多飞桨 Wheel 版本请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html)。

#### 更多安装方式

关于**源码编译**安装等更多安装方式，及**昆仑芯**、**海光**、**寒武纪**、**昇腾**等飞桨版本，请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=undefined)。

### 1.2 验证

使用以下命令可以验证 PaddlePaddle 是否安装成功。

```bash
python -c "import paddle; paddle.utils.run_check()"
```

查看 PaddlePaddle 版本的命令如下：

```bash
python -c "import paddle; print(paddle.__version__)"
```

## 2. 安装 PaddleX

### 2.1 获取源码

#### 【推荐】从 GitHub 下载

使用下述命令从 GitHub 获取 PaddleX 最新源码。

```shell
git clone https://github.com/PaddlePaddle/PaddleX.git
```

<!-- #### 从 Gitee 下载

如果访问 GitHub 网速较慢，可以从 Gitee 下载（Gitee 源码每日同步），命令如下：

```shell
git clone https://gitee.com/paddlepaddle/PaddleX.git
``` -->

### 2.2 安装配置及依赖

参考下述命令，按提示操作，完成 PaddleX 依赖的安装。

```bash
cd PaddleX
python install_pdx.py
```