Driver and Software Installation

The following sections describe how to obtain and install Intel® Gaudi® software and drivers.

Installation Options

The following lists the available options for Intel Gaudi software stack installation:

• Install Intel Gaudi software stack: Installs all the packages automatically using habanalabs-installer.sh script. This is the recommended installation method.

• Upgrade Intel Gaudi software stack: Enables upgrading an existing installation to the latest version.

• Install Intel Gaudi software packages individually: Allows installing each package manually for a fine-grained control over the installation process.

Note

• Make sure to review the currently supported versions and operating systems listed in the Support Matrix.

• Driver and software installation is not required if you are using the Intel Gaudi Base Operator for Kubernetes or OpenShift.

• Installing the package with internet connection available allows the network to download and install the required dependencies for the Intel Gaudi software package (apt get, yum, dnf install or pip install etc.).

Install Intel Gaudi Software Stack

1. Install the Intel Gaudi software stack using habanalabs-installer.sh script. For further details on the package installers included, see Intel Gaudi Software Installers table.

   wget -nv https://vault.habana.ai/artifactory/gaudi-installer/1.18.0/habanalabs-installer.sh
   chmod +x habanalabs-installer.sh
   ./habanalabs-installer.sh install --type base
   

   For further instructions on how to control the script attributes, refer to the help guide by running the following command:

   ./habanalabs-installer.sh --help
   

Note

• The installation sets the number of huge pages automatically.

• habanalabs-container-runtime and habanalabs-qual-workloads are not automatically installed with the habanalabs-installer.sh. Make sure to install them as shown in the steps below. Additionally, habanatools is not automatically installed. If you are using TPC and writing your own kernels, refer to TPC Tools Installation Guide to install habanatools package.

2. (Optional) Install habanalabs-container-runtime package. This package is required for running workloads in containers. Both Docker and Kubernetes are supported:

   Ubuntu 24.04

    sudo apt install -y habanalabs-container-runtime
   

   Ubuntu 22.04

    sudo apt install -y habanalabs-container-runtime
   

   Amazon Linux 2

    sudo yum install -y habanalabs-container-runtime
   

   RHEL 8.6

    sudo dnf install -y habanalabs-container-runtime
   

   RHEL 9.2

    sudo dnf install -y habanalabs-container-runtime
   

   RHEL 9.4

    sudo dnf install -y habanalabs-container-runtime
   

   TencentOS 3.1

    sudo dnf install -y habanalabs-container-runtime
   

   SUSE 15.5

    sudo zypper install -y habanalabs-container-runtime
   

3. (Optional) Install habanalabs-qual-workloads package. This package is required for running ResNet-50 training stress test plugin:

   Ubuntu 24.04

    sudo apt install -y habanalabs-qual-workloads
   

   Ubuntu 22.04

    sudo apt install -y habanalabs-qual-workloads
   

   Amazon Linux 2

    sudo yum install -y habanalabs-qual-workloads
   

   RHEL 8.6

    sudo dnf install -y habanalabs-qual-workloads
   

   RHEL 9.2

    sudo dnf install -y habanalabs-qual-workloads
   

   RHEL 9.4

    sudo dnf install -y habanalabs-qual-workloads
   

   TencentOS 3.1

    sudo dnf install -y habanalabs-qual-workloads
   

   SUSE 15.5

    sudo zypper install -y habanalabs-qual-workloads
   

4. Bring up the network interfaces by running the command below. Ensure the network interfaces are brought up when training using external Gaudi network interfaces between servers for multi-server scale-out. These interfaces need to be brought up every time the kernel module is loaded or unloaded and reloaded. A reference on how to bring up the interfaces is provided in the manage_network_ifs.sh. Before bringing up the network interfaces, make sure to install ethtool according to your operating system. Note that the script can be found at /opt/habanalabs/qual/[gaudi3,gaudi2,gaudi1]/bin/.

   # manage_network_ifs.sh requires ethtool
   /opt/habanalabs/qual/[gaudi3,gaudi2,gaudi1]/bin/manage_network_ifs.sh --up
   

Upgrade Intel Gaudi Software Stack

1. Upgrade Intel Gaudi software stack, run the following command:

    wget -nv https://vault.habana.ai/artifactory/gaudi-installer/1.18.0/habanalabs-installer.sh
    chmod +x habanalabs-installer.sh
    ./habanalabs-installer.sh upgrade --type base
   

2. Perform Steps 2, 3 and 4 from the previous section Install Intel Gaudi Software Stack to complete the upgrade.

Install Intel Gaudi Software Packages Individually

To install each package individually, refer to Installing Intel Gaudi Software Packages Individually.

Note

While you can install each package manually, using the habanalabs-installer.sh script is the recommended method for installation. For further details, see Install Intel Gaudi Software Stack.