下载
中文
注册

参数说明

软件包支持根据命令行完成一键式安装,各个命令之间可以配合使用,用户根据安装需要选择对应参数完成安装,所有参数都是可选参数。

安装命令格式: ./*.run [options]

详细参数请参见表1

如果通过./*.run --help命令查询出的参数未解释在如下表格,则说明该参数预留或适用于其他产品类型,用户无需关注。

表1 安装包支持的参数说明

参数

说明

--help | -h

查询帮助信息。

--info

查询软件包构建信息。

--list

查询软件包文件列表。

--check

检查软件包的一致性和完整性。

--quiet | -q

静默安装或升级,跳过交互式信息。

使用此参数安装或升级时,将默认签署华为企业业务最终用户许可协议(EULA)

--nox11

不使用x11模式运行。

--noexec

不执行安装脚本。配套--extract=<path>使用,格式为:--noexec --extract=<path>。

--extract=<path>

解压软件包中文件到指定目录。使用该参数时,用户无需手动建立指定的目录,解压过程中会自动创建,例如:--noexec --extract=./package,则命令执行后会自动将解压后的内容放在package目录。

--tar arg1 [arg2 ...]

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

--install

安装软件包。后面可以指定安装路径--install-path=<path>,也可以不指定安装路径,直接安装到默认路径下。

说明:

针对kernels包,使用--install参数会安装除静态库之外的所有的文件。

--devel

仅软件包toolkit,nnrt,kernels支持使用该参数

按照开发模式安装软件包,即只安装开发环境需安装的文件。

说明:

针对kernels包,使用--devel参数会安装所有的文件,包括动态库和静态库。

--full

仅软件包toolkit支持使用该参数

支持在无驱动场景下实现全量安装。

--install-path=<path>

指定安装、升级和卸载路径,需配合安装--install、升级--upgrade和卸载--uninstall参数使用。当环境上已存在全局配置文件“ascend_cann_install.info”时,该参数指定的路径必须与全局配置文件中保存的安装路径保持一致。如用户想更换安装路径,请删除全局配置文件“ascend_cann_install.info”或者修改全局配置文件内的安装路径为指定路径,同时建议卸载原路径下的CANN软件包。

可在如下目录查看是否存在该文件:

  • root用户:/etc/Ascend
  • 非root用户:${HOME}/Ascend

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

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

若通过该参数指定了安装目录,root用户需要对指定的安装路径有755权限,非root用户需要750权限。

--install-for-all

安装或升级时,允许其他用户具有安装群组的权限。

当安装或者升级携带该参数时,软件包中创建的目录及文件,其他用户权限=安装群组权限。

该参数需要与--install、--devel、--upgrade等其中一个参数配合使用,例如:

1
./*.run --install --install-for-all
说明:

使用该参数将会存在安全风险:其他所有用户都有权限访问安装目录,请谨慎使用。

--force

强制安装、升级命令。当安装、升级检测不通过导致安装或升级失败时,则会提示用户使用该参数跳过安装检测,使用后方可安装或升级成功。

该参数需要配合安装和升级类参数(“--install”、“--upgrade”、“--devel”或“--full”)一起使用。

--feature

仅软件包toolkit、nnrt、nnae、kernels支持使用该参数

toolkit、nnrt、nnae安装/升级时和kernels安装时可以通过该参数指定某些特性

  • toolkit、nnrt、nnae软件包当前取值仅支持输入“ascendc”,表示只安装公共必选的文件和已标识AscendC算子开发特性的文件,未标识AscendC算子开发特性的文件会跳过不安装。需注意,ascendc特性在只包括Kernel开发(基于Kernel Launch算子工程,通过基础调用(Kernel Launch)方式调用算子),不包含ACLNN开发(通过单算子API执行的方式开发单算子调用应用)。

    该参数需要与“--install”“--devel”“--full”“--upgrade”配合使用,例如:

    1
    ./*.run --install --feature=ascendc
    
  • kernels软件包当前取值范围如下,支持单个或者多个特性同时输入:
    • aclnn_ops_infer:由于推理库依赖数学库,所以安装时如果携带了该参数,表示安装公共必选的文件、已标识aclnn_ops_infer特性(即NN网络算子推理库)的文件和已标识aclnn_math特性(即数学库)的文件。
    • aclnn_ops_train:由于训练库依赖推理库、随机数算子库和数学库,所以安装时如果携带了该参数,表示安装公共必选的文件、已标识aclnn_ops_train特性(即NN网络算子训练库)的文件、已标识aclnn_ops_infer特性(即NN网络算子推理库)的文件、已标识aclnn_rand特性(即随机数算子库)的文件和已标识aclnn_math特性(即数学库)的文件。
    • aclnn_math:表示只安装公共必选的文件和已标识aclnn_math特性(即数学库)的文件。
    • aclnn_rand:表示只安装公共必选的文件和已标识aclnn_rand特性(即随机数算子库)的文件。
    说明:
    • 如上各个库对应的算子接口范围请参考《算子加速库接口参考》的“NN算子接口列表”章节
    • 多次选择特性安装时,新特性为增量安装,不会覆盖已安装特性。

--whitelist=<feature_type>

仅软件包toolkit和nnae支持使用该参数

可选安装白名单,用于在执行安装或升级的时候指定部分可选安装特性,需根据参数功能配合“--install”和“--upgrade”一起使用。

  • nnae:仅安装nnae包相关特性,用于支持离线推理、在线推理、训练以及IR构图场景。仅支持toolkit包使用。
  • nnrt:仅安装nnrt包相关特性,用于支持离线推理场景。仅支持toolkit包使用。
  • hccl:仅安装hccl基础依赖包和nnrt包,主要用于多机多卡推理场景,支持toolkit和nnae包使用。
  • hccl-only:仅安装hccl基础依赖包,支持toolkit和nnae包使用。
  • atc:仅安装ATC转换工具特性,用于支持模型编译、模型转换。仅支持toolkit包使用。
  • devtools:仅安装开发工具包,主要为调测、仿真工具。选择安装该特性时请配套安装nnae。仅支持toolkit包使用。

--chip=<chip_type>

仅软件包toolkit、nnrt、nnae支持使用该参数。未指定此参数时,默认安装软件包内的全部AICPU算子包。

指定昇腾产品类型,以便在安装过程中选择匹配的软件(如AICPU算子包)。

--upgrade

升级已安装的软件,支持在低版本升级至高版本场景下使用。

如果需要从高版本回退至低版本,需卸载高版本后重新安装所需版本。

说明:

kernels软件包升级功能仅支持8.0.RC2及更高的版本。

--feature-list=<feature>

仅软件包toolkit、nnae支持使用该参数

指定升级特性。仅支持升级使用,参数仅支持输入“Acclibs”(独立升级算子包),如“--feature-list=Acclibs”。

该参数需要配合“--upgrade”一起使用。

说明:

推荐用户全量升级。如果版本配套表中有算子包独立升级的兼容性列表,则参考该兼容性列表,否则推荐用户全量升级。

--uninstall

卸载已安装的软件。

--type=<package_type>

仅软件包kernels支持使用该参数

指定已安装的CANN软件包类型,用于在执行安装(--install)时指定跟随安装的软件包(“nnae”“nnrt”“toolkit”),以识别到具体的安装目录。该参数需要配合“--install”或“--upgrade”一起使用。

--version

仅软件包toolkit、nnrt、nnae、kernels、tfplugin支持使用该参数

查询版本信息。

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

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