FeatureRetrieval安装、卸载和升级

建议使用普通用户进行安装和运行。MindX SDK依赖于CANN包的低权限用户的动态库，使用root用户运行程序时，存在链接的动态库被低权限用户篡改的安全风险。
当前特征检索基于开放形态设计和发布，开放形态下的HDC通信机制受HwHiAiUser用户属组控制，滥用HwHiAiUser属组权限可能引发特征检索服务不可用或信息泄露等风险。
包括HDC通信机制在内，针对开放形态文件系统的恶意篡改和攻击所带来的安全隐患不在华为所管理的安全风险范围内，进行下一步的安装和使用前，请确保已知悉上述情形。
安装、升级或者卸载时会在用户的“$HOME/log/mxIndex/deployment.log”日志文件中记录事件。

FeatureRetrieval以二进制共享库形式发布，软件包在本地用户自定义路径通过run包安装。

安装FeatureRetrieval

当前支持的昇腾硬件平台为昇腾310 AI处理器和Atlas 推理系列产品。

以软件包的安装用户登录安装环境。
将软件包上传到安装环境的任意路径下（如：“/home/package”）并进入软件包所在路径。

增加对软件包的可执行权限。

chmod +x Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run

执行如下命令，校验软件包的一致性和完整性。

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --check

若显示如下信息，说明软件包已通过校验。

Verifying archive integrity...  100%   SHA256 checksums are OK. All good.

创建软件包的安装路径。
- 若用户想指定安装路径，需要先创建安装路径。以安装路径“/home/work/FeatureRetrieval”为例：
```
mkdir -p /home/work/FeatureRetrieval
```
- 若用户未指定安装路径，软件会默认安装到软件包所在的路径。

安装软件包，用户需确保整个安装过程由root用户执行，安装路径和解压路径仅允许root用户访问。

若用户指定了安装路径。以安装路径“/home/work/FeatureRetrieval”为例：

对于昇腾310 AI处理器：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --install --install-path=/home/work/FeatureRetrieval --platform=310

对于Atlas 推理系列产品：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --install --install-path=/home/work/FeatureRetrieval --platform=310P

若用户未指定安装路径，安装路径默认为当前软件包所在路径：

对于昇腾310 AI处理器：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --install --platform=310

对于Atlas 推理系列产品：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --install --platform=310P

安装完成后会生成目录“mxIndex-{version}”，若显示如下信息，则表示软件成功安装。

Uncompressing ASCEND MXINDEX RUN PACKAGE  100%

具体安装命令的参数介绍，请参见表1。

表1 可选参数表
输入参数	含义
--help \| -h	查询帮助信息。
--check	查询包完整性。
--install	在当前目录安装mxIndex。
--install-path=<path>	设置mxIndex自定义安装目录。
--version	查询安装包mxIndex版本。
--upgrade	将mxIndex升级到安装包所包含的mxIndex版本。
--platform	NPU类型，支持“310”（默认）和“310P”（即昇腾310 AI处理器和Atlas 推理系列产品）。

安装FeatureRetrieval。
1. 进入安装目录“mxIndex-{version}”。
```
cd mxIndex-{version}
```
2. 进入ops目录，编译算子前需要设置“ASCEND_HOME”和“ASCEND_VERSION”环境变量，默认分别为“/usr/local/Ascend和ascend-toolkit/latest”
```
export ASCEND_HOME=/usr/local/Ascend          # Ascend home path
export ASCEND_VERSION=ascend-toolkit/latest   # atc/opp/toolkit installation path
export ASCEND_OPP_PATH=/usr/local/Ascend/ascend-toolkit/latest/opp # opp installation path
```
  - “ASCEND_HOME”表示“driver/ascend-toolkit”等组件所在路径。
  - “ASCEND_VERSION”表示当前使用的Ascend版本，如果ATC工具安装路径是“/usr/local/Ascend/ascend-toolkit/latest”则无需设置“ASCEND_HOME”和“ASCEND_VERSION”，另外用户需要“ASCEND_OPP_PATH”目录的写权限。
3. 根据实际系统架构执行对应脚本。
  - ARM架构对应“custom_opp_aarch64.run”。
  - x86_64架构对应“custom_opp_x86_64.run”。
```
./custom_opp_{arch}.run
```
4. 进入“tools”目录，编译算子，如果要编译自定义算子参考自定义算子介绍。
  - 对于昇腾310 AI处理器：
```
cd ../tools && python3 run_generate_model.py
```
  - 对于Atlas 推理系列产品：
```
cd ../tools && python3 run_generate_model.py -t 310P
```
5. 将算子模型文件移动到源码目录下的“modelpath”目录下（用户需要确保生成的算子om文件不被篡改）。
```
mv op_models/* ../modelpath
```
6. 执行以下命令完成环境部署。（“install.sh”必须以root用户执行，用户需要确保“mxIndex”安装目录所有文件不被篡改。）
  - 对于昇腾310 AI处理器，<driver-untar-path>为“Ascend310-driver-{software version}-minios.aarch64-src.tar.gz”文件解压后的目录。
```
cd .. && bash install.sh -d <driver-untar-path>
```
  - 对于Atlas 推理系列产品，<driver-untar-path>为“Ascend310P-driver-{software version}-minios.aarch64-src.tar.gz”文件解压后的目录。
```
cd .. && bash install.sh -d <driver-untar-path> -t 310P
```
    对于Atlas 推理系列产品，还需进行安全启动操作。
    
    上述“install.sh”脚本封装了《CANN 软件安装指南 (开放态, Atlas 推理系列产品)》中“定制文件系统 > 压缩文件系统 > 部署修改后文件系统”步骤，执行后会在当前路径下（以“/usr/local/filesys_modify”为例）生成“Ascend310P.cpio.gz”文件（请根据实际生成的文件名称为准）。
    
    脚本执行完成后，继续按照“对文件系统镜像文件进行签名前预处理”以及后续步骤操作，即可完成Atlas 300I Pro 推理卡的安全启动功能。
7. 执行命令重启，完成部署。
```
reboot
```

卸载FeatureRetrieval

进入安装目录mxIndex-{version}。
```
cd mxIndex-{version}
```
进入“script”目录。
```
cd script
```
添加“uninstall.sh”文件可执行权限，并执行，完成卸载。
```
chmod +x uninstall.sh
./uninstall.sh
```

升级FeatureRetrieval

FeatureRetrieval升级操作参考以下命令执行。

对于昇腾310 AI处理器：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --upgrade --platform=310

对于Atlas 推理系列产品：

./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --upgrade --platform=310P

父主题： 安装指导