Parameter Description

This section describes the options related to the software package in .run format. The software package in .run format supports one-click installation using command line options. The commands can be used together. You can select installation options as required. All options are optional.

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

For details, see Table 1.

If an option queried by running the ./xxx.run --help command is not in the following table, the option is either reserved or applies to other product types. You can ignore them.
The following options 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 construction 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 the --install or --upgrade option.

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 together 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 command is executed, the decompressed files are automatically stored in the package directory.

--tar arg1 [arg2 ...]

Runs the tar command on the software package. Use the parameters following tar as the command parameters. 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

This parameter is supported only by Toolkit and ops packages.

Installs a software package in development mode. That is, only the files required for the development environment are installed.

--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 users: ${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 user group permission during installation or upgrade.

If this parameter is specified during installation or upgrade, other users can use CANN to run services. However, this option has security risks. Exercise caution when using this option.

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

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

--force

Specifies the forced 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

This parameter is supported only by the NNAL package.

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

Note that the Python library is installed in the site-packages directory of Python. The example path is /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 software package supports this parameter. In the current version, this parameter is unavailable for the ops package.

This parameter can be used to specify some features during Toolkit installation or upgrade.

Currently, the value of the Toolkit software package can only be ascendc, indicating that only common mandatory files and files marked with the Ascend C operator development feature are installed. Files not marked with the Ascend C operator development feature are skipped and not installed. Note that the ascendc feature includes only kernel development (which involves calling operators in basic mode based on the kernel launch operator project) and does not include ACLNN development (which involves developing single-operator applications in single-operator API execution mode).

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

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

--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 conjunction with --install or --upgrade.

Only the Toolkit software package supports this parameter.

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

Only the ops software package supports this parameter.

nnrt: Offline inference is supported. It is mainly used for model inference of applications.

This parameter is supported only by the NNAL package.

atb: Only the ATB acceleration library has been installed.
SIP: Only the SiP acceleration library is installed.
all: Both the ATB and SiP acceleration libraries are installed.

--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 install the required version.

--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 software package. This parameter is used to specify the software Toolkit package to be installed during the installation (--install) in order to identify the specific installation directory. This parameter must be used together with --install, --uninstall, or --upgrade.

--version

Queries version information.

Parent topic: Appendix A: Reference