昇腾社区首页
中文
注册
开发者
下载

安装Index SDK

安装须知

  • 安装和运行Index SDK的用户,需要满足:
    • 安装和运行Index SDK的用户需为同一用户,且必须与安装CANN为同一用户,否则存在运行生成算子时访问CANN的权限问题。
    • 安装和运行Index SDK的用户建议为普通用户。Index SDK依赖于CANN包的低权限用户的动态库,使用root用户运行程序时,存在链接的动态库被低权限用户篡改的安全风险。
    • 安装包所在目录、安装目标目录的属主必须为安装用户。
    • 安装Index SDK时必须保证有“~”目录且安装用户对该目录有读、写权限。
  • 特征检索以二进制共享库形式发布,软件包在本地用户自定义路径通过run包安装。

安装步骤

  1. 以软件包的安装用户登录安装环境。
  2. 将软件包上传到安装环境的任意路径下(如:“/home/work/FeatureRetrieval”)并进入软件包所在路径。
  3. 增加对软件包的可执行权限。
    chmod +x Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run
  4. 执行如下命令,校验软件包的一致性和完整性。
    ./Ascend-mindxsdk-mxindex_{version}_linux-{arch}.run --check

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

    1
    Verifying archive integrity...  100%   SHA256 checksums are OK. All good.    
    
  5. 创建软件包的安装路径。
    • 若用户未指定安装路径,软件会默认安装到软件包所在的路径。
    • 若用户想指定安装路径,需要先创建安装路径。以安装路径“/home/work/FeatureRetrieval”为例:
      1
      mkdir -p /home/work/FeatureRetrieval
      
  6. 获取安装命令。请在下方根据实际情况单击对应选项,获取Index SDK的安装命令。
    表1 快速安装详细信息

    产品系列

    产品型号

    CPU架构

    是否指定安装路径

    安装命令

    Atlas 200/300/500 推理产品

    Atlas 300I 推理卡(型号 3000)

    aarch64

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310

    # 安装路径默认为命令执行所在目录。

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310

    # 安装路径默认为命令执行所在目录。

    Atlas 300I 推理卡(型号 3010)

    aarch64

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310

    # 安装路径默认为命令执行所在目录。

    x86_64

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310

    # 安装路径默认为命令执行所在目录。

    Atlas 推理系列产品

    Atlas 300I Pro 推理卡

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310P

    # 安装路径默认为命令执行所在目录。

    Atlas 300V 视频解析卡

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310P

    # 安装路径默认为命令执行所在目录。

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    Atlas 300V Pro 视频解析卡

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    Atlas 300I Duo 推理卡

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    Atlas 200I SoC A1 核心板

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=310P
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=310P
    

    # 安装路径默认为命令执行所在目录。

    Atlas A2 推理系列产品

    Atlas 800I A2 推理服务器

    x86_64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --install-path=/home/work/FeatureRetrieval --platform=npu_type
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换;npu_type表示芯片名称,可在安装昇腾AI处理器的服务器执行npu-smi info命令进行查询,将查询到的“Name”最后一位数字删除,即是npu_type的取值

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-x86_64.run --install --platform=npu_type
    

    # 安装路径默认为命令执行所在目录;npu_type表示芯片名称,可在安装昇腾AI处理器的服务器执行npu-smi info命令进行查询,将查询到的“Name”最后一位数字删除,即是npu_type的取值

    aarch64

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=npu_type
    

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换;npu_type表示芯片名称,可在安装昇腾AI处理器的服务器执行npu-smi info命令进行查询,将查询到的“Name”最后一位数字删除,即是npu_type的取值

    1
    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=npu_type
    

    # 安装路径默认为命令执行所在目录;npu_type表示芯片名称,可在安装昇腾AI处理器的服务器执行npu-smi info命令进行查询,将查询到的“Name”最后一位数字删除,即是npu_type的取值

    Atlas 800I A3 超节点服务器

    Atlas 800I A3 超节点服务器

    aarch64

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --install-path=/home/work/FeatureRetrieval --platform=A3

    # 该命令以安装路径“/home/work/FeatureRetrieval”为例,请根据实际情况进行替换。

    ./Ascend-mindxsdk-mxindex_7.2.RC1_linux-aarch64.run --install --platform=A3

    # 安装路径默认为命令执行所在目录

  7. 执行安装命令,安装软件包。用户需确保整个安装过程由同一用户执行,安装路径和解压路径仅允许该用户访问。

    --install安装命令同时支持输入可选参数,如表2所示。输入不在列表中的参数可能正常安装或者报错。

  8. 安装过程中提示Do you accept the EULA to install mxIndex?时,输入Y或y,表示同意EULA协议,继续进行安装;输入其他字符时停止安装,退出程序。
    安装完成后会生成目录“mxIndex-{version},若显示如下信息,则表示软件成功安装。
    1
    Uncompressing ASCEND MXINDEX RUN PACKAGE  100%   
    
  9. 添加Index软件包路径的环境变量。以Index SDK的安装路径“/home/work/FeatureRetrieval”为例:
    export LD_LIBRARY_PATH=/home/work/FeatureRetrieval/mxIndex/host/lib/:$LD_LIBRARY_PATH

相关参考

表2 --install安装命令可选参数表

参数名称

说明

--help | -h

查询帮助信息。

--info

查询包构建信息。

--list

查询文件列表。

--check

查询包完整性。

--quiet|-q

可选参数,表示静默安装。使用该参数,默认同意华为企业业务最终用户许可协议(EULA),跳过协议签署过程,并减少人机交互的信息的打印。

--nox11

不使用x11模式运行,当前未使用。

--noexec

解压软件包到当前目录,但不执行安装脚本。配套--extract=<path>使用,格式为:--noexec --extract=<path>。

--extract=<path>

解压软件包中文件到指定目录。可配套--noexec、--install、--upgrade之一参数使用。

--tar arg1 [arg2 ...]

对软件包执行tar命令,使用tar后面的参数作为命令的参数。例如执行--tar xvf命令,解压run安装包的内容到当前目录。

--version

查询安装包Index SDK版本。

--install

特征检索软件包安装操作命令。

--install-path=<path>

(可选)自定义特征检索软件包安装根目录。如未设置,默认为当前命令执行所在目录。配置的路径必须以/~开头,路径取值仅支持大小写字母、数字、-_./字符。

若不指定,将安装到默认路径下:

  • 若使用root用户安装,默认安装路径为:/usr/local/Ascend。
  • 若使用非root用户安装,则默认安装路径为:${HOME}/Ascend。

若通过该参数指定了安装目录该目录other用户不能有写权限,如果指定普通用户安装,安装目录属主必须为当前安装用户。

--upgrade

特征检索软件包升级操作命令,将特征检索升级到安装包所包含的Index SDK版本。

--platform

对应昇腾AI处理器类型。

  • 使用Atlas 200/300/500 推理产品请输入“310”
  • 使用Atlas 推理系列产品请输入“310P”
  • 使用Atlas 800I A3 超节点服务器请输入“A3”。
  • 使用Atlas A2 推理系列产品,请在安装昇腾AI处理器的服务器执行npu-smi info命令进行查询,将查询到的“Name”最后一位数字删掉,即是--platform的取值。

以下参数未展示在--help参数中,用户请勿直接使用。

  • --xwin:使用xwin模式运行。
  • --phase2:要求执行第二步动作。