hls4ml-tutorial: Tutorial notebooks for hls4ml

July 28, 2026 ยท View on GitHub

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

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