Main menu#

The Main menu is the installation starting point.

Pre-Install Configuration Settings menu#

The Pre-Install Configuration Settings menu is an optional menu used to configure pre-installation requirements before installation. The pre-installation settings relate to the dependent libraries and packages required by the ROCm runtime or the AMDGPU driver.

• File

  File displays the location of the deps_list.txt file. This file is based on the combination of selected dependencies using the ROCm and Driver checkboxes and either Display Dependencies or Validate Dependencies. If Display Dependencies is selected, deps_list.txt includes a list of all required dependencies. If Validate Dependencies is selected, deps_list.txt contains only the missing dependencies on the system that still require installation. The File field is initially blank until Display Dependencies or Validate Dependencies is selected.

• ROCm / Driver

  The ROCm and Driver checkboxes are used to select which dependencies you want to display, validate, or install.

• Display Dependencies

  Display Dependencies lists all required (Debian or RPM) packages that must be pre-installed on the system. These packages are required by ROCm or the AMDGPU driver being installed by a particular ROCm Runfile Installer version.

  Note

  The required packages are listed in the deps_list.txt file and can be installed separately from the ROCm Runfile Installer.

• Validate Dependencies

  Validate Dependencies verifies which required packages are currently installed on the system where ROCm or the AMDGPU driver is being installed. It displays which packages from the required packages list are missing.

  Note

  The missing packages are listed in the deps_list.txt file.

• Install Dependencies

  If the installer is running on the system where ROCm or the AMDGPU driver will be installed, you can choose to install any missing dependencies using the Install Dependencies option.

  Note

  Install Dependencies is only intended for a system with network or internet access. For offline installation using the ROCm Runfile Installer, you must manually install the required packages. For more details, see the Dependency requirements section.

ROCm Options menu#

The ROCm Options menu can include or exclude ROCm from the installation.

• Install ROCm

  This field indicates whether to include ROCm components in the installation. If this field is set to yes, ROCm installation is enabled and the Runfile Installer searches the system for any existing ROCm installations. If a previous ROCm installation is detected, the Uninstall ROCm field becomes selectable.

• ROCm Component List

  If Install ROCm is set to yes, this field displays a list of all ROCm components and component versions included in the installation.

• ROCm Install Path

  If Install ROCm is set to yes, the ROCm Install Path field can set the full path to the directory where ROCm will be installed. The default location is /, which is the typical /opt/rocm ROCm installation location.

  When ROCm Install Path is set to a new path, the installer validates the new directory location. If the directory exists, the ROCm installation can proceed. If an invalid location is specified, the ROCm installation will not be allowed.

• Uninstall ROCm

  This field is only available if previous Runfile ROCm installations are discovered on the system where ROCm is being installed. The previous installation locations are listed and can be selected for uninstall. Uninstall ROCm is for a single ROCm instance at a time and is only available for Runfile installs. Package manager installs of ROCm cannot be uninstalled by the Runfile installer and must be uninstalled manually using the package management application.

  

Driver Options menu#

The Driver Options menu can include or exclude the AMDGPU driver from the installation.

• Install Driver

  This field indicates whether to include the AMDGPU driver in the installation. If this field is set to yes, AMDGPU driver installation is enabled. When this field is enabled, the system is searched for any existing AMDGPU driver installations. If a previous AMDGPU driver installation is detected, the Uninstall Driver field becomes selectable.

• Start on install

  If the Start on install option is enabled, the Runfile installer uses modprobe to automatically launch the AMDGPU driver after installation. If a pre-existing AMDGPU driver is already loaded on the system, the new driver will not start. This option can be useful for installing the driver on a system where the GPU device is newer and not yet natively supported as part of the upstream GPU driver for the Linux distribution.

• Uninstall Driver

  This field is only available if a previous Runfile install of the AMDGPU driver is discovered on the install system. If a Runfile installation of the AMDGPU driver is detected, select Uninstall Driver to remove it. Package manager installs of the AMDGPU driver cannot be uninstalled by the Runfile installer and must be uninstalled manually using the package management application.

Post-Install Options menu#

Use the Post-Install Options menu to optionally enable additional setup and configuration items after the initial ROCm install.

• Set GPU access permissions

  This section sets the GPU access permissions after the ROCm installation. Typically, any ROCm component using the GPU and requiring access to GPU resources needs to set the access permission. For ROCm, GPU access is controlled by membership in the video and render groups. Membership and access to GPU resources can be set using one of two methods.

  • Add video,render group

    If the Add video,render group field is enabled, the current $USER is added to the groups and will be granted GPU access.

  • Add udev rule

    If the Add udev rule field is enabled, GPU access is granted to all users on the system.

  Note

  It’s recommended that you enable one of the GPU access options for using ROCm.

  Only one method for adding GPU access can be selected.

• Post ROCm setup

  When this option is enabled, the ROCm post-install setup is performed. This includes configuring symbolic links and other system requirements for using ROCm and the ROCm runtime.

  Tip

  It’s recommended that you enable the Post ROCm setup to guarantee proper functioning of the ROCm components and applications. However, advanced users who understand the ROCm setup might want to disable this option so they can control the post-installation ROCm setup for their specific environment.

Runfile options#

The ROCm Runfile Installer is a self-extracting .run file with a few options for controlling the extraction process. When the installer .run file starts execution, the extraction process begins with a checksum validation to verify the integrity of the .run file. If there are no errors, it begins extracting and decompressing the package contents. The contents are output to a new directory named rocm-installer, located in the current working directory.

Usually, when extraction and decompression are complete, execution begins automatically by either starting up the GUI (if no arguments are provided) or executing the rocm-installer.sh script with all command line arguments. The rocm-installer.sh script is in the extracted rocm-installer directory.

When the GUI exits or the command line completes execution, the Runfile installer will automatically clean up the rocm-installer directory and delete all content except for the log files and the deps_list.txt file.

In some cases, you might want to execute multiple commands from the same extraction and save the time required to verify the checksum and extract and decompress the package contents of the .run file. Two command line options let you disable the .run cleanup process: noexec and noexec-cleanup.

• noexec

  The noexec option is a single command line argument that lets the checksum and extraction process complete and then exits without starting the GUI or executing the rocm-installer.sh script. All content will be maintained after the exit. You can then use the rocm-installer.sh script directly from the command line without specifying the .run file name.

  For example, extract the .run file and then use rocm-installer.sh instead of rocm-installer.run to install ROCm and the AMDGPU driver separately:

  bash rocm-installer.run noexec
  cd rocm-installer
  bash rocm-installer.sh rocm
  bash rocm-installer.sh amdgpu
  

  Note

  If the noexec option is used, all other <options> on the command line will be ignored.

• noexec-cleanup

  The noexec-cleanup option disables the cleanup process after the GUI or command line interface exits. Unlike the noexec option, all command line arguments are processed as normal, but no content is deleted upon exit or completion. At this point, you can switch to using the rocm-installer.sh script within the rocm-installer directory to avoid re-extracting the contents.

Dependency options#

Like the GUI Pre-Install Configuration menu, the command line interface can list, validate, and install the required dependencies. At the command line, add the deps=<arg> <compo> option to the list of <options> for the .run file. The <compo> option can include any combination of the rocm and amdgpu tags.

• deps=list <rocm/amdgpu>

  This dependency option lists all the dependencies required for the .run file-based ROCm installation, AMDGPU installation, or both. It lists all required (Debian or RPM) packages that require pre-installation on the system. The additional rocm or amdgpu parameter is a requirement for the deps=list option that instructs the installer to list only the dependencies required by ROCm, the AMDGPU driver, or both.

  Running deps=list causes the installer to quit after listing the dependencies. deps=list can combine rocm and amdgpu and output the combined list of required dependencies.

  Use deps=list <rocm/amdgpu> as a single <options> parameter:

  bash rocm-installer.run deps=list rocm
  bash rocm-installer.run deps=list amdgpu
  bash rocm-installer.run deps=list rocm amdgpu
  

  Note

  The list of required packages can be installed separately from the Runfile Installer.

• deps=validate <rocm/amdgpu>

  This dependency option verifies whether any of the required ROCm or AMDGPU driver packages in the dependency list are already installed on the system running the command. The output is a list of any missing dependency packages that require installation.

  Running deps=validate causes the installer to quit after listing the missing dependencies. deps=validate can combine rocm and amdgpu and output the combined list of missing dependencies.

  Use deps=validate <rocm/amdgpu> as a single <options> parameter:

  bash rocm-installer.run deps=validate rocm
  bash rocm-installer.run deps=validate amdgpu
  bash rocm-installer.run deps=validate rocm amdgpu
  

  Note

  The list of missing packages can be installed separately from the Runfile Installer.

• deps=install

  This dependency option validates and installs any required packages in the dependency list for ROCm, the AMDGPU driver, or both that are missing on the system running the command. This dependency option is not a single <options> parameter and can be added to a list of other options for the installer. The deps=install option expects at least one of the rocm or amdgpu <options> parameters to also be present in the list to enable the pre-installation of required dependencies before the Runfile Installer installs ROCm, the AMDGPU driver, or both.

  For example, to install the dependencies and ROCm, the command line is as follows:

  bash rocm-installer.run deps=install rocm
  

  To install the dependencies and the AMDGPU driver, the command line is as follows:

  bash rocm-installer.run deps=install amdgpu
  

  To install the dependencies and both ROCm and the AMDGPU driver, the command line is as follows:

  bash rocm-installer.run deps=install rocm amdgpu
  

  Note

  The installer can be set to only install the ROCm dependencies, AMDGPU dependencies, or both and then quit. In this case, add -only to the deps=install option:

  bash rocm-installer.run deps=install-only rocm
  bash rocm-installer.run deps=install-only amdgpu
  bash rocm-installer.run deps=install-only rocm amdgpu
  

• deps=file <file-path>

  This dependency option specifies the name of a input file for the installer. This file contains a custom list of dependency packages to install. The list must have as the same format as the output of the deps=list option. Specify each (Debian or RPM) package by name, one package per line. <file-path> is the second parameter, which indicates the absolute path to the dependency file.

  For example, to install the dependencies listed in a file named mydeps.txt as part of a ROCm install, the command line is as follows:

  bash rocm-installer.run deps=file /home/amd/mydeps.txt
  

  Note

  The installer can be set only to install the dependencies file and then quit. In this case, add -only to deps=file.

  bash rocm-installer.run deps=file-only /home/amd/mydeps.txt
  

Install options#

Like the GUI ROCm Options menu, the ROCm Runfile Installer can be configured to install ROCm, which can be installed in a specific location.

• rocm

  At the command line, add the rocm option to enable ROCm installation.

  Note

  This option must be in the list of .run <options> for ROCm component installation.

  For example, to install ROCm with no other options, the command line is as follows:

  bash rocm-installer.run rocm
  

• target=<directory>

  This install option is used to set the target directory where ROCm will be installed. The target option is only used as an option for ROCm installation and is not required for an AMDGPU driver install.

  When target=<directory> is not specified in the <options> list, the installer uses a default installation path for ROCm. For the command line interface method, the default install directory is $PWD. This is the current working directory where you launched the installer. In this configuration, the installer creates a new directory inside $PWD named rocm and installs all ROCm components to this location.

  The user can change the default location and set the ROCm component installation directory using the target=<directory> option. The <directory> argument must be a valid and absolute path to a directory on the system executing the ROCm Runfile Installer.

  For example, to install ROCm to the usual /opt/rocm location, the command line is as follows:

  bash rocm-installer.run target="/" rocm
  

  To install ROCm to a directory called amd/myrocm in the $USER directory, the command line is as follows:

  bash rocm-installer.run target="/home/amd/myrocm rocm"
  

• amdgpu

  At the command line, add the amdgpu option to enable AMDGPU driver installation.

  Note

  This option must be in the list of .run <options> for AMDGPU driver installation.

  For example, to install the AMDGPU driver with no other options, the command line is as follows:

  bash rocm-installer.run amdgpu
  

  Note

  Both rocm and amdgpu can be combined in the <options> list to install both components. For this case, the command line is as follows:

  bash rocm-installer.run rocm amdgpu
  

• force

  The force install option can be added to the <options> list for the case of multiple pre-existing Runfile installs of ROCm. Add this option to disable any installer prompts that ask for confirmation to continue with the ROCm install if there are currently one or more Runfile ROCm installations already on the system.

Post-install options#

Similar to the GUI Post-Install Options menu, the post-install options can configure the ROCm Runfile Installer to apply additional post-installation options after completing the installation. At the command line, add one or more of the post-installation options to the <options> list for the .run file.

• postrocm

  This post-install option applies any post-installation configuration settings for ROCm following installation on the target system. The post-installation configuration includes any symbolic link creation, library configuration, and script execution required to use the ROCm runtime.

  To enable the ROCm post-install configuration, add postrocm to the <options> list at the command line.

  For example, to enable ROCm post-installation configuration for a ROCm installation to the / directory, the command line is as follows:

  bash rocm-installer.run target="/" rocm postrocm
  

  Note

  Adding the postrocm option to the <options> list is highly recommended to guarantee proper functioning of the ROCm components and applications.

• gpu-access=<access_type>

  This post-install option sets the GPU resource access permissions. ROCm runtime libraries and applications might need access to the GPU. This requires setting the access permission to the video and render groups using the <access_type>.

  If the ROCm installation is for a single user, then set the <access_type> for the gpu-access option to user.

  For example, to add the current user ($USER) to the video,render group for GPU access for a ROCm installation, the command line is as follows:

  bash rocm-installer.run rocm gpu-access=user
  

  In cases where a system administrator is installing ROCm for multiple users, they might want to enable GPU access permission for all users. For this case, set the <access_type> for the gpu-access option to all:

  bash rocm-installer.run rocm gpu-access=all
  

  Note

  Adding the gpu-access option to the <options> list is recommended for using ROCm. A typical ROCm installation includes both the postrocm option and one of the gpu-access types.

Uninstall options#

These options configure the ROCm Runfile Installer to uninstall a previous ROCm or AMDGPU driver installation.

• uninstall-rocm (target=<directory>)

  This option configures the ROCm Runfile Installer to uninstall a previous ROCm installation.

  The parameter target=<directory> is optional for the uninstall-rocm option. If it’s set, the uninstall looks for a pre-existing ROCm installation at the specified directory path and attempts to remove it.

  To uninstall ROCm from the default location ($PWD/rocm), use the following command line:

  bash rocm-installer.run uninstall-rocm
  

  Note

  This command matches the case where ROCm was installed without the target=<directory> option. To uninstall ROCm from a specific location, append target=<directory>. For example, if ROCm was previously installed to /home/amd/myrocm, use the following command line:

  bash rocm-installer.run uninstall-rocm target="/home/amd/myrocm"
  

  Note

  The uninstall-rocm option can only remove ROCm if it was installed using the ROCm Runfile Installer. Traditional package-based ROCm installs will not be removed.

• uninstall-amdgpu

  This option configures the ROCm Runfile Installer to uninstall a previous AMDGPU driver installation.

  To uninstall the AMDGPU driver from the system, use the following command line:

  bash rocm-installer.run uninstall-amdgpu
  

  Note

  The uninstall-amdgpu option can only remove the AMDGPU driver if it was installed using the ROCm Runfile Installer. Traditional package-based AMDGPU driver installs will not be removed.

Information and debug options#

The ROCm Runfile Installer command line interface includes options for information output or debugging.

• findrocm

  This information option searches the install system for any existing installations of ROCm. Any install locations are output to the terminal.

  Use findrocm as a standalone <options> parameter:

  bash rocm-installer.run findrocm
  

• complist

  This information option lists the version of each ROCm component included in the installer. The complist option causes the Runfile Installer to quit after listing the ROCm components.

  Use complist as a standalone <options> parameter:

  bash rocm-installer.run complist
  

• prompt

  This debug option enables user prompts in the installer. At specific, critical points of the installation process, the installer halts execution and prompts the user to either continue with the install or exit.

• verbose

  This debug option enables verbose logging during ROCm Runfile Installer execution.

  For example, to install ROCm with user prompts and verbose logging, the command line is as follows:

  bash rocm-installer.run target="/" rocm prompt verbose