Ying-Hsiang - Run through tutorial

[nikiburggraf]

Execute tutorial, specifically parts 1-4

Create issues in this repo for any problems you run into, especially with environment setup

Feel free also to ping me with whatever you run into

[hinxcode]

I've run the part 1 locally and experienced the following steps:

1. Switch to hls4ml-tutorial env:

conda env create -f environment.yml
conda activate hls4ml-tutorial

2. Pull the prebuilt image and start the container (I chose Docker with Vivado version since I did not install Vivado on my laptop)

docker pull ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.1:latest
docker run -p 8888:8888 -v /PATH/TO/YOUR/HLS4ML_FOLDER:/home/jovyan/work ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.1:latest  

NOTE:

1. Please note that the image hls4ml-0.8.0-vivado-2019.2 mentioned on README is NOT EXISTED. So I chose hls4ml-0.8.0-vivado-2019.1 instead.
2. I encountered the error no matching manifest for linux/arm64/v8 in the manifest list entries while pulling images since I'm using an ARM laptop (Apple M1) and there is no image for arm64. (You can check packages here) So I installed the image for linux/amd64 and it went well so far.
3. In order to mount the project folder, I added -v /PATH/TO/YOUR/HLS4ML_FOLDER:/home/jovyan/work parameter.
4. I encountered no space left for docker while pulling image, and I increased virtual disk limit from 64 GB to 120 GB in docker setting.

3. Open 127.0.0.1:8888 with the generated token. Enjoy my training on my local jupyter notebook. By the way, I found this slides really helpful for learning hls4ml.

[hinxcode]

Besides running tutorials locally, I am not able to run online either in the binder or http://tutorials.fastmachinelearning.org/. It seems like there is no Vivado installed on these cloud environments.