AscendPyTorch

简介

本项目开发了PyTorch Adapter插件，用于昇腾适配PyTorch框架，为使用PyTorch框架的开发者提供昇腾AI处理器的超强算力。用户在准备相关环境进行基于PyTorch框架模型的开发、运行时，可以选择在服务器中手动编译相关模块。

前提条件

• 需完成CANN开发或运行环境的安装，具体操作请参考《CANN 软件安装指南》。
• Python支持版本为3.7.5、3.8、3.9。

系统依赖库

CentOS & EulerOS

yum install -y patch zlib-devel libffi-devel openssl-devel libjpeg-turbo-devel gcc-c++ sqlite-devel dos2unix openblas git dos2unix

yum install -y gcc==7.5.0 cmake==3.12.0

Ubuntu

apt-get install -y patch g++ make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev m4 dos2unix libopenblas-dev git dos2unix

apt-get install -y gcc==7.5.0 cmake==3.12.0

说明： 若安装gcc与cmake依赖命令报错，请参考FAQ使用源码安装。

Ascend配套软件

安装方式

安装PyTorch依赖环境

如果使用非root用户安装，用户需要在本步骤的每句命令后加**--user**，示例如：pip3 install pyyaml --user。

pip3 install pyyaml
pip3 install wheel

编译安装PyTorch和昇腾插件

首先安装官方torch包，然后编译安装插件。

#x86_64
pip3 install torch==1.11.0+cpu #若使用pip命令安装cpu版本PyTorch报错，请手动下载whl包安装，下载地址：（https://download.pytorch.org/whl/torch）

#aarch64（推荐使用镜像）
1.可在docker中使用AscendHub镜像仓库提供的基于PyTorch版本制作的基础镜像，包含训练、转换和推理等功能。
#镜像仓库地址：（https://ascendhub.huawei.com/#/detail/pytorch-modelzoo）
2.鲲鹏arm服务器可在鲲鹏开源软件文件共享中心获取编译好的PyTorch二进制安装包。
#鲲鹏文件共享中心地址：（https://mirrors.huaweicloud.com/kunpeng/archive/Ascend/PyTorch/）
3.社区未提供的arm架构cpu安装包，可参见FAQ第一条，使用源码编译安装pytorch。

编译生成pytorch插件的二进制安装包。

# 下载master分支代码，进入插件根目录
git clone -b master https://gitee.com/ascend/pytorch.git 
cd pytorch    
# 指定python版本编包方式：
bash ci/build.sh --python=3.7
# 或
bash ci/build.sh --python=3.8
# 或
bash ci/build.sh --python=3.9

然后安装pytorch/dist下生成的插件torch_npu包，{arch}为架构名称。

pip3 install --upgrade dist/torch_npu-1.11.0-cp37-cp37m-linux_{arch}.whl

下载torchvision。

pip3 install torchvision==0.12.0

运行

运行环境变量

在当前仓库根目录中执行设置环境变量脚本

source env.sh

自定义环境变量

可选的环境变量可能会对运行的模型产生影响:

export COMBINED_ENABLE=1 # 非连续转连续二级推导优化，可选，开启设置为1。当模型中有大量AsStrided高耗时算子被调用时，可以尝试开启此优化以获得潜在的device执行效率的提升。
export ACL_DUMP_DATA=1 # 算子数据dump功能，调试时使用，可选，开启设置为1

表 1 环境变量说明

执行单元测试脚本

验证运行, 输出结果OK

cd test/test_network_ops/
python3 test_div.py

安装混合精度模块（可选）

AscendPyTorch1.11.0集成了AMP模块，也可用于混合精度训练等应用场景，与Apex模块的区别如下，请用户根据功能需要选择使用，若需安装Apex模块请参考相关README文档进行编译安装Apex模块。

• AMP

  • 动态loss scale：动态计算loss scale的值并判断是否溢出。
  • 不支持tensor融合功能。

• APEX

  • O1配置模式：Conv，Matmul等使用float16精度计算，其他如softmax、BN使用float32精度。
  • O2配置模式：除BN使用float32精度外，其他部分使用float16精度。
  • 静态loss scale：静态设置参数确保混合精度训练收敛。
  • 动态loss scale：动态计算loss scale的值并判断是否溢出。

文档

有关安装指南、模型迁移和训练/推理教程和API列表等更多详细信息，请参考用户文档。

建议与交流

热忱希望各位在用户社区加入讨论，并贡献您的建议，我们会尽快给您回复。

分支维护策略

Ascend PyTorch的版本分支有以下几种维护阶段：

现有分支维护状态

FAQ

CPU架构为ARM架构时，由于社区未提供ARM架构CPU版本的torch包，无法使用PIP3命令安装PyTorch，需要使用源码编译安装。

下载PyTorch v1.11.0源码包。

git clone -b v1.11.0 https://github.com/pytorch/pytorch.git --depth=1 pytorch_v1.11.0

进入源码包获取被动依赖代码。

cd pytorch_v1.11.0
git submodule sync
git submodule update --init --recursive 

配置环境变量

export USE_XNNPACK=0

执行编译安装。

python3 setup.py install

在PIP设置为华为源时，安装requirments.txt中的typing依赖后，会导致python环境错误。

在PIP设置为华为源时，需打开requirments.txt文件，删除typing依赖，再执行命令。

pip3 install -r requirments.txt

编译过程执行bash build.sh报错no module named yaml/typing_extensions.

pytorch编译依赖 yaml库和typing_extensions库，需要手动安装。

pip3 install pyyaml

pip3 install typing_extensions

安装成功后，注意需要执行make clean在执行bash build.sh进行编译，否则可能因缓存出现未知编译错误。

运行遇到找不到te问题

开发态:

cd /urs/local/Ascend/ascend-toolkit/latest/{arch}-linux/lib64  #{arch}为架构名称

pip3 install --upgrade topi-0.4.0-py3-none-any.whl

pip3 install --upgrade te-0.4.0-py3-none-any.whl

用户态:

cd /urs/local/Ascend/nnae/latest/{arch}-linux/lib64  #{arch}为架构名称

pip3 install --upgrade topi-0.4.0-py3-none-any.whl

pip3 install --upgrade te-0.4.0-py3-none-any.whl

命令行安装cmake依赖时提示找不到包、编译cmake报错版本过低，可使用安装脚本或源码编译安装。

方法一：下载安装脚本安装cmake。（参考cmake官网）

​ X86_64环境脚本安装：cmake-3.12.0-Linux-x86_64.sh

​ aarch64环境脚本安装：cmake-3.12.0-Linux-aarch64.sh

1. 执行命令。

   ./cmake-3.12.0-Linux-{arch}.sh #{arch}为架构名称
   

2. 设置软连接。

   ln -s /usr/local/cmake/bin/cmake /usr/bin/cmake
   

3. 执行如下命令验证是否安装成功。

   cmake --version
   

   如显示“cmake version 3.12.0”则表示安装成功。

方法二：使用源码编译安装。

1. 获取cmake软件包。

   wget https://cmake.org/files/v3.12/cmake-3.12.0.tar.gz --no-check-certificate
   

2. 解压并进入软件包目录。

   tar -xf cmake-3.12.0.tar.gz
   cd cmake-3.12.0/
   

3. 执行配置、编译和安装命令。

   ./configure --prefix=/usr/local/cmake
   make && make install
   

4. 设置软连接。

   ln -s /usr/local/cmake/bin/cmake /usr/bin/cmake
   

5. 执行如下命令验证是否安装成功。

   cmake --version
   

   如显示“cmake version 3.12.0”则表示安装成功。

命令行安装gcc依赖时提示找不到包、编译时gcc报错问题

部分源下载gcc时会提示无法找到包，需要使用源码编译安装。

以下步骤请在root用户下执行。

1. 下载gcc-7.5.0.tar.gz，下载地址为https://mirrors.tuna.tsinghua.edu.cn/gnu/gcc/gcc-7.5.0/gcc-7.5.0.tar.gz。

2. 安装gcc时候会占用大量临时空间，所以先执行下面的命令清空/tmp目录：

   sudo rm -rf /tmp/*
   

3. 安装依赖（以CentOS和Ubuntu系统为例）。

   • CentOS执行如下命令安装。

     yum install bzip2    
     

   • Ubuntu执行如下命令安装。

     apt-get install bzip2    
     

4. 编译安装gcc。

   1. 进入gcc-7.5.0.tar.gz源码包所在目录，解压源码包，命令为：

      tar -zxvf gcc-7.5.0.tar.gz
      

   2. 进入解压后的文件夹，执行如下命令下载gcc依赖包：

      cd gcc-7.5.0
      ./contrib/download_prerequisites
      

      如果执行上述命令报错，需要执行如下命令在“gcc-7.5.0/“文件夹下下载依赖包：

      wget http://gcc.gnu.org/pub/gcc/infrastructure/gmp-6.1.0.tar.bz2
      wget http://gcc.gnu.org/pub/gcc/infrastructure/mpfr-3.1.4.tar.bz2
      wget http://gcc.gnu.org/pub/gcc/infrastructure/mpc-1.0.3.tar.gz
      wget http://gcc.gnu.org/pub/gcc/infrastructure/isl-0.16.1.tar.bz2
      

      下载好上述依赖包后，重新执行以下命令：

      ./contrib/download_prerequisites
      

      如果命令校验失败，需要确认上述依赖包在文件夹中的唯一性，无重复下载，若存在重复的依赖包，需删除。

   3. 执行配置、编译和安装命令：

      ./configure --enable-languages=c,c++ --disable-multilib --with-system-zlib --prefix=/usr/local/linux_gcc7.5.0
      make -j15    # 通过grep -w processor /proc/cpuinfo|wc -l查看cpu数，示例为15，用户可自行设置相应参数。
      make install    
      

      须知： 其中“--prefix“参数用于指定linux_gcc7.5.0安装路径，用户可自行配置，但注意不要配置为“/usr/local“及“/usr“，因为会与系统使用软件源默认安装的gcc相冲突，导致系统原始gcc编译环境被破坏。示例指定为“/usr/local/linux_gcc7.5.0“。

   4. 修改软连接。

      ln -s ${install_path}/gcc-7.5.0/bin/gcc /usr/bin/gcc
      ln -s ${install_path}/gcc-7.5.0/bin/g++ /usr/bin/g++
      ln -s ${install_path}/gcc-7.5.0/bin/c++ /usr/bin/c++
      

   5.配置环境变量。

   当用户执行训练时，需要用到gcc升级后的编译环境，因此要在训练脚本中配置环境变量，通过如下命令配置。

   export LD_LIBRARY_PATH=${install_path}/lib64:${LD_LIBRARY_PATH}
   

   其中${install_path}为3.中配置的gcc7.5.0安装路径，本示例为“/usr/local/gcc7.5.0/“。

   说明： 本步骤为用户在需要用到gcc升级后的编译环境时才配置环境变量。

若存在pytorch编译不过，请检查软连接的库是否正确。

libstdc++->libstdc++.so.6.0.24(7.5.0)

找不到libblas.so问题

环境缺少openblas库，需要安装openblas库

Centos，EulerOS环境

yum -y install openblas

Ubuntu环境

apt install libopenblas-dev

容器中未挂载device问题

在容器中运行脚本出现NPU相关ERROR。由于启动容器实例时，未挂载device参数，导致无法正常启动实例。

请用户参考以下命令，重启容器。

docker run -it --ipc=host \
--device=/dev/davinciX \
--device=/dev/davinci_manager \
--device=/dev/devmm_svm \
--device=/dev/hisi_hdc \
-v /usr/local/Ascend/driver \
-v /usr/local/dcmi \
-v /usr/local/bin/npu-smi \
${镜像名称}:{tag} \
/bin/bash

参数说明：

/dev/davinciX：NPU设配，X是芯片物理ID号例如davinci0。

/dev/davinci_manager：管理设备。

/dev/devmm_svm：管理设备。

/dev/hisi_hdc：管理设备。

/usr/local/Ascend/driver：驱动目录。

/usr/local/dcmi：DCMI目录。

/usr/local/bin/npu-smi：npu-smi工具。

${镜像名称}:{tag}：镜像名称与版本号。

安装-torch--whl-提示-torch-1-5-0xxxx-与-torchvision-所依赖的版本不匹配

安装“torch-*.whl”时，提示"ERROR：torchvision 0.6.0 has requirement torch==1.5.0, but you'll have torch 1.5.0a0+1977093 which is incompatible"。

安装torch时，会自动触发torchvision进行依赖版本检查，环境中安装的torchvision版本为0.6.0，检查时发现我们安装的torch-*.whl的版本号与要求的1.5.0不一致，所以提示报错，但实际安装成功 。

对实际结果无影响，无需处理。

import torch_npu 显示_has_compatible_shallow_copy_type重复注册warning问题

warning如下图所示，由Tensor.set_data浅拷贝操作触发。主要原因是PyTorch插件化解耦后，_has_compatible_shallow_copy_type缺乏对NPU Tensor的浅拷贝判断支持，因此需要重新注册_has_compatible_shallow_copy_type。

该warning不影响模型的精度和性能，可以忽略。

待NPU 设备号合入社区或者后续PyTorch版本_has_compatible_shallow_copy_type注册方式发生变动，该warning会被解决。

在编译torch_npu的目录进入python引用torch_npu报错问题

验证torch_npu的引入，请切换至其他目录进行，在编译目录执行会提示如下错误。

在执行import torch_npu时出现ModuleNotFooundError: NO module named '_lzma'报错问题

在python命令行下，执行import torch_npu测试时，出现ModuleNotFooundError: NO module named '_lzma'问题，可能由于Python环境失效，重装Python即可。

编译过程中出现XNNPACK相关的Make Error报错

编译原生pytorch时，未配置相关环境变量，导致编译不成功。

1. 执行命令设置环境变量

   export USE_XNNPACK=0
   

2. 执行命令清除当前编译内容

   make clean
   

3. 重新编译

编译时出现Breakpad error: field 'regs' has incomplete type 'google_breakpad::user_regs_struct'报错

编译原生pytorch时，未配置相关环境变量，导致编译不成功。

1. 执行命令配置环境变量

   export BUILD_BREAKPAD=0
   

2. 执行命令清除当前编译内容

   make clean
   

3. 重新编译

多卡训练初始化阶段卡顿至超时

init_process_group 函数中使用了IPV6地址，例如::1(注意localhost 可能指向IPv6的地址)，使用IPv4可以避免这个问题

版本说明

版本说明请参阅ReleseNote