Home

Awesome

hls4ml-tutorial: Tutorial notebooks for hls4ml

Jupyter Book Badge deploy-book Code style: black pre-commit Binder

There are several ways to run the tutorial notebooks:

Online

Binder

Conda

Running the tutorials requires AMD Vitis HLS to be installed, see here. After the installation, the necessary environmental variables can be set using

source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh

The Python environment used for the tutorials is specified in the environment.yml file. It can be setup like:

conda env create -f environment.yml
conda activate hls4ml-tutorial
source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh

Note that part 7 of the tutorial makes use of the VivadoAccelator backend of hls4ml for which no Vitis equivalent is available yet. For this part of the tutorial it is therefore necesary to install and source Vivado HLS version 2019.2 or 2020.1, which can be obtained here.

Companion material

We have prepared a set of slides with some introduction and more details on each of the exercises. Please find them here.

Notebooks