安装说明¶

前置条件¶

系统版本: Linux, macOS, Windows

Python 版本: 3.7-3.9

Note

如果您的设备具有 NVIDIA GPU ，参考 NVIDIA CUDA Toolkit 安装。

在安装好 CUDA 之后，当您在安装 DI-engine 的依赖项时，会自动获取和安装带有 NVIDIA CUDA 加速的深度学习框架（例如PyTorch）。

如您需要手动安装适合本机 Python 版本和 GPU 设备的 PyTorch 版本，您可以参考 PyTorch 安装。

此外，如果您的操作系统是 Windows ，请您检查是否拥有 SWIG Windows 应用程序，您可以参考 SWIG 安装，并将 SWIG 的可执行文件添加至 Windows 系统环境变量 PATH 路径中。

发布版本¶

您可以使用以下命令安装 DI-engine 的稳定发行版：

# Current stable release of DI-engine
pip install DI-engine

Tip

如果你需要升级 pip 版本，可以使用以下命令：

# Windows
> python -m pip install --upgrade pip
# Linux
$ pip install --upgrade pip
# MacOS
$ pip install --upgrade pip

Tip

如果您在下载软件包时遇到超时错误，您可以尝试采用更换其他常用镜像源，例如使用阿里源：

pip install requests -i https://mirrors.aliyun.com/pypi/simple/ DI-engine

如果您需要借助 Anaconda 或者 Miniconda , 建议您采用如下命令:

conda install -c opendilab di-engine

开发版本¶

如果您需要从 Github 源码安装最新的 DI-engine 开发版本，可以使用如下方法：

git clone https://github.com/opendilab/DI-engine.git
cd DI-engine
pip install .

Tip

如果您希望将 DI-engine 的安装目录设置为操作系统的当前用户目录，您可以使用如下方式：

pip install . --user

如果您正在使用诸如 virtualenv 等程序生成的虚拟 python 环境，--user 选项将不会生效。

特殊版本¶

如果您希望启用 DI-engine 的额外功能并安装相关依赖，可以使用如下方法：

# install atari and box-2d related packages
pip install DI-engine[common_env]
# install unittest(pytest) related packages
pip install DI-engine[test]
# enable numba acceleration
pip install DI-engine[fast]
# install multi extra packages
pip install DI-engine[common_env,test,fast]

Tip

某些类型的终端可能需要将安装包名称的整体，使用引号注释后才能生效该指令，如下所示：

pip install 'DI-engine[common_env,test,fast]'

Note

取决于安装内容与网络状态，安装耗时一般为 30 秒左右。如果在该过程中有一些特定的依赖项未能成功安装，您可以参考 “setup.py” 文件中的版本要求，然后手动安装它。如果遇到难以解决的安装问题，可以在 DI-engine 的 ISSUE 区提问，我们会尽快解答

使用 Docker 运行¶

DI-engine 的镜像可以在 DockerHub 获得。拉取镜像的方法如下：

# Download Stable release DI-engine Docker image
docker pull opendilab/ding:nightly
# Run Docker image
docker run -it opendilab/ding:nightly /bin/bash

安装检查¶

安装完毕之后，您可以使用如下 python 命令检查 DI-engine 是否可用，并查看该 DI-engine 的版本信息:

import ding
print(ding.__version__)

您也可以直接在终端使用 DI-engine 的命令行工具：

ding -v