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

参数说明

本章节介绍了run格式软件包相关参数说明,run格式软件包支持通过命令行参数进行一键式安装,各个命令之间可以配合使用,用户根据安装需要选择对应参数,所有参数都是可选参数。

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

详细参数请参见表1

  • 如果通过./xxx.run --help命令查询出的参数未解释在如下表格,则说明该参数为预留参数或适用于其他产品类型,用户无需关注。
  • 以下参数未展示在--help参数中,用户请勿直接使用。
    • --xwin:使用xwin模式运行。
    • --phase2:要求执行第二步动作。
表1 参数说明

参数

说明

--help | -h

查询帮助信息。

--info

查询软件包构建信息。

--list

查询软件包文件列表。

--check

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

--quiet | -q

静默安装或升级,跳过交互式信息,需配合--install或--upgrade参数使用。

使用此参数安装或升级时,将默认签署华为企业业务最终用户许可协议(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>,也可以不指定安装路径,直接安装到默认路径下。

--devel

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

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

--full

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

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

--install-path=<path>

指定操作路径,需配合安装--install、升级--upgrade和卸载--uninstall参数使用。

当环境上已存在全局配置文件“ascend_cann_install.info”时,该参数指定的路径会自动重置该文件中的安装路径,并在原路径下创建时间戳文件夹,备份旧配置文件。

可在如下目录查看是否存在全局配置文件“ascend_cann_install.info”:

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

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

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

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

--install-for-all

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

当安装或者升级携带该参数时,支持其他用户使用CANN运行业务,但该参数存在安全风险,请谨慎使用。

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

1
./xxx.run --install --install-for-all

--force

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

该参数需要配合--install、--upgrade、--devel或--full一起使用。

--torch_atb

仅软件包nnal支持使用该参数。

安装Python库时使用,需配合--install和--upgrade参数使用。

需注意,Python库会安装在Python的site-packages目录下,示例路径:“/usr/local/python3.10/lib/python3.10/site-packages”,可执行如下命令查看已安装Python库版本。

pip3 list

--feature

仅软件包toolkit支持使用该参数,当前版本该参数在ops包上暂不可用

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

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

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

1
./xxx.run --install --feature=ascendc

--whitelist=<feature_type>

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

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

  • nnae:用于支持离线推理、在线推理、训练以及IR构图场景。
  • nnrt:用于支持离线推理场景,主要用于应用程序的模型推理。
  • hccl:主要用于多机多卡推理场景。
  • hccl-only:仅安装hccl基础依赖包。
  • atc:仅安装ATC转换工具特性,用于支持模型编译、模型转换。
  • devtools:仅安装开发工具包,主要为调测、仿真工具。

仅软件包ops支持使用的参数。

nnrt:用于支持离线推理场景,主要用于应用程序的模型推理。

仅软件包nnal支持使用的参数。
  • atb:只安装ATB加速库。
  • SIP:只安装SiP加速库。
  • all:同时安装ATB加速库和SiP加速库。

--upgrade

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

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

--feature-list=<feature>

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

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

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

说明:

推荐用户全量升级。

--uninstall

卸载已安装的软件。

--type=<package_type>

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

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

--version

查询版本信息。