安装指南

先决条件

操作系统版本：Linux, macOS, Windows

Python 版本：3.7-3.9

注意

如果你的设置中有GPU，你可以参考NVIDIA CUDA Toolkit Installation

安装CUDA后，在安装DI-engine时，您将自动获得正确版本的NVIDIA CUDA深度学习框架（例如，Pytorch）。

如果你想手动安装Pytorch，可以参考PyTorch Installation。

如果您的操作系统是Windows，请确认SWIG已安装并且可以通过操作系统环境变量PATH访问，您可以参考SWIG安装。

稳定发布版本

您可以通过以下命令简单地安装稳定版本的DI-engine：

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

提示

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

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

提示

如果在下载包时遇到超时，您可以尝试从其他站点请求。

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 .

提示

如果您希望将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]

提示

某些特定的shell需要在包名周围加上引号，如下所示：

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

注意

整个安装过程通常持续约30秒，这取决于包的大小以及下载速度。 如果某些包安装失败，您可以参考文件“setup.py”并手动安装特定的包。 如果遇到一些棘手的安装问题，您可以向DI-engine的ISSUE寻求帮助。

在Docker中运行

DI-engine 的 Docker 镜像可以在 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是否可用并显示其版本：

import ding
print(ding.__version__)

你也可以尝试使用DI-engine的命令行工具，如下所示：

ding -v