Register on the Hailo website and obtain the necessary materials

The AI software suite and all development tools are free, but registration on the Hailo website is required.

The Hailo website is as follows:

https://hailo.ai/

You can get various tools and documents from the Developer Zone, which can be accessed from the top right of the site. You will be asked to register the first time, so please fill in the necessary information and complete the registration.

You can view a list of materials related to the AI Software Suite by going to the Documentation tab in the Developer Zone and filtering as follows:

This article is based on the contents of the following documents, so please check the details as necessary.

　Hailo AI Software Suite User Guide
　Hailo Dataflow Compiler User Guide
　HailoRT User Guide

Preparing the Computer/Workstation

The AI Software Suite requires a PC/workstation with a GPU. The requirements are as follows:

　・Ubuntu 20.04/22.04, 64 bit
　・16+ GB RAM (32+ GB recommended)
　・Docker package, either docker.io 20.10.07 (from Ubuntu repo), or docker-ce 20.10.6 (from Docker website)

You will also need to install the following package for the PCIe Driver (HailoRT).

　・build-essential package (needed for compiling the PCIe driver)
　・(Optional) bison, flex, libelf-dev and dkms packages (needed to register the PCIe driver using DKMS)
　・(Optional) curl (needed to download the firmware when installing without the PCIe driver)
　・(Optional) cmake (needed for compiling the HailoRT examples)
　・(Optional) pip and virtualenv (needed for pyhailort)
　・(Optional) systemd (needed for Multi-Process service)

A GPU is not required, but we recommend that you install a GPU since there are some functions that cannot be supported without a GPU for quantization and optimization for Hailo devices. The GPU requirements are as follows:

　・Nvidia’s Pascal/Turing/Ampere GPU architecture (such as Titan X Pascal, GTX 1080 Ti, RTX 2080 Ti, or RTX A4000)
　・GPU driver version 525
　・nvidia-docker2

Preparing for Hailo-8

To see the Hailo-8 in action, you need to physically connect it.

The Starter Kit (see the screen below, left) prepared by Hailo can be purchased individually, making it the perfect kit for evaluation. However, only M.2 modules (M/B+M/A+E key) or mPCIe modules are prepared. It would be fine if you had free space in the M.2 module, but if not, we recommend using a PCIe-M.2 conversion board, which can be purchased for around 1,000 to 2,000 yen, to connect to the PCIe slot.

In fact, we also use a PCIe-M.2 conversion module to connect, as shown in the photo on the right below.

To purchase the Hailo-8 Starter kit, please contact us using the "Contact us" button at the end of this page.

(PCIe-M.2 conversion boards are not available, so please purchase them separately.)

File download

Download the relevant files from SW Downloads in the Developer Zone of the Hailo website.

Below is the link, which is only available to registered customers.

https://hailo.ai/developer-zone/software-downloads/

Download “Hailo AI Software Suite – Docker” and “HailoRT – PCIe driver Ubuntu package (deb)”.

The downloaded file name is as follows:

hailo_ai_sw_suite_2024-04_docker.zip
hailort-pcie-driver_4.17.0_all.deb

Installing AI Software Suite

Move the two downloaded files to a suitable folder and unzip the zip file.

First, install the PCIe Driver.

Execute the following command in the folder where you saved the file.

$ sudo dpkg --install hailort-pcie-driver_4.17.0_all.deb

If you don't have any particular preference, set DKMS to Y.

It should take a few minutes to complete, then reboot.

Next, start the AI Software Suite container.

Go to the folder where you unzipped hailo_ai_sw_suite_2024-04_docker.zip and execute the following command.

$ ./hailo_ai_sw_suite_docker_run.sh

It will take about 15 minutes to deploy the container the first time, but once complete you will be able to enter the AI Software Suite container as shown in the screen below.

To exit the container, use the exit command.

$ exit

If you want to enter the same container again, add the resume option as follows:

$ ./hailo_ai_sw_suite_docker_run.sh --resume

Please run the following command in the AI Software Suite container. If there are no problems, installation and recognition of the Hailo device should be fine.

$ hailo -h

(The results are shown on the left screen below.)

$ hailortcli scan

(The results are shown on the right screen below.)

This completes the installation of AI Software Suite.

Please refer to the following article for actual usage.

　②How to use Dataflow Compiler (how to create hef files)

　③How to use HailoRT (running inference using hef files)

Hailo manufacturer information Top

If you would like to return to the Hailo manufacturer information top page, please click below.