Parameter Description

This chapter describes the parameters for runfiles. Runfiles support one-click installation using command-line arguments, and various parameters can be combined based on user needs. All parameters are optional.

Installation command syntax: ./xxx.run [options]

For details, see Table 1.

Parameters displayed by ./xxx.run --help but not listed in the table below are reserved or intended for other product types. You can safely ignore them.
The following parameters are not displayed in --help. Do not use them directly.
- --xwin: uses the xwin operating mode.
- --phase2: performs the second step.

Table 1 Parameter description

Parameter

Description

--help | -h

Queries help information.

--info

Queries software package build information.

--list

Queries the software package list.

--check

Checks the consistency and integrity of software packages.

--quiet | -q

Indicates a silent upgrade or installation, which skips interactive messages. This parameter must be used together with --install or --upgrade .

When this parameter is used for installation or upgrade, Huawei Enterprise End User License Agreement (EULA) is signed by default.

--nox11

Indicates that the X11 mode is not used.

--noexec

Skips the execution of the installation script. It is used in pair with --extract=<path> in the format of --noexec --extract=<path>.

--extract=<path>

Decompresses a software package to a specified directory. When this parameter is used, a directory is automatically created during the extraction. For example, after the --noexec --extract=./package.run command is executed, the decompressed files are automatically stored in the package directory.

--tar arg1 [arg2 ...]

Runs the tar command on the runfile. Use the options following tar as the command-line options. For example, the --tar xvf command indicates that the RUN package will be decompressed to the current directory.

--install

Installs a software package. You can specify the installation path --install-path=<path> or use the default installation path.

--devel

Only the combined driver & Toolkit package, Toolkit, and ops support this parameter.

Installs a software package in development mode, that is, install only the files required by the development environment.

--full

Only the Toolkit software package supports this parameter.

Full installation is supported when no driver is installed.

--install-path=<path>

Specifies the operation path. It must be used together with --install, --upgrade, and --uninstall.

If the global configuration file ascend_cann_install.info already exists in the environment, the installation path specified by this parameter is automatically reset to the path in the file, and a timestamp folder is created in the original path to back up the old configuration file.

Check whether the global configuration file ascend_cann_install.info exists in the following directory:

root user: /etc/Ascend
Non-root user: ${HOME}/Ascend

If you do not specify the path, the default path is used.

For installation as the root user, the default installation path is /usr/local/Ascend.
For installation as a non-root user, the default installation path is ${HOME}/Ascend.

If an installation directory is specified by this parameter, the root user must have the 755 permission on this directory, and a non-root user must have the 750 permission on this directory.

--install-for-all

Allows all users to have the same installation group permission.

When this parameter is included during installation or upgrade, other users are allowed to use CANN to run businesses. However, this parameter poses security risks and must be used with caution.

This parameter must be used together with --install, --devel or --upgrade. For example:

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

--force

Specifies the forcible installation and upgrade command. If the installation or upgrade fails due to the installation or upgrade check failure, the system prompts you to use this parameter to skip the check to make the installation or upgrade succeed.

This parameter must be used together with --install, --upgrade, --devel, or --full.

--torch_atb

Only the NNAL package supports this parameter.

Used to install the Python library. This parameter must be used together with the --install and --upgrade parameters.

Note that the Python library is installed in the site-packages directory of Python, for example, /usr/local/python3.10/lib/python3.10/site-packages. You can run the following command to view the version of the installed Python library:

pip3 list

--feature

Only the Toolkit and ops software packages support this parameter. In the current version, this parameter does not take effect.

--whitelist=<feature_type>

Specifies the optional installation trustlist, which is used to specify certain optional features during installation or upgrade. This parameter must be used in pair with --install or --upgrade based on the parameter function.

Values supported by the combined driver & Toolkit package:

toolkit: installs only the Toolkit in the combined package.
driver: installs only the driver in the combined package.
all: installs both the driver and Toolkit.

Only the Toolkit supports this parameter.

nnae: supports offline inference, online inference, training, and IR graph building.
nnrt: supports offline inference, mainly used for model inference of applications.
hccl: supports multi-node multi-card inference.
hccl-only: installs only the HCCL basic dependency package.
atc: Only the ATC conversion tool feature is installed to support model compilation and conversion.
devtools: installs only the development tool package to provide debugging and simulation tools.

Only the ops software package supports this parameter.

nnrt: supports offline inference, mainly used for model inference of applications.

Only the NNAL package supports this parameter.

atb: installs only the ATB.
sip: installs only the SiP.
all: installs both the ATB and SiP.

--upgrade

Upgrades the installed software from an earlier version to a later version.

If you need to roll back from a later version to an earlier version, uninstall the later version and then install the required version.

The combined driver & Toolkit package does not support this parameter.

--feature-list=<feature>

Only the Toolkit software package supports this parameter.

Specifies the upgrade feature. This parameter is used only for upgrade. The value can only be Acclibs (independent upgrade of the OPP), for example, --feature-list=Acclibs.

This parameter must be used together with --upgrade.

NOTE:

A full upgrade is recommended.

--uninstall

Uninstalls the software that has been installed.

--type=<package_type>

Only the ops software package supports this parameter.

Specifies the type of the installed CANN package. This option is used to specify the Toolkit package to be installed during the installation (--install) in order to identify the specific installation directory. This option must be used together with --install, --uninstall, or --upgrade.

--version

Queries version information.

Parent topic: Appendix A: Reference