Skip to content

Commit a9a7b51

Browse files
authored
Merge branch 'main' into pre-commit-ci-update-config
2 parents 98ae14c + b907a60 commit a9a7b51

21 files changed

+417
-500
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
channels: conda-forge
2626
activate-environment: hls4ml-tutorial
2727
environment-file: environment.yml
28-
python-version: 3.10.10
28+
python-version: 3.10.16
2929
auto-activate-base: false
3030

3131
# Check dependencies

.github/workflows/docker-publish.yml

Lines changed: 0 additions & 38 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -13,51 +13,21 @@ There are several ways to run the tutorial notebooks:
1313
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fastmachinelearning/hls4ml-tutorial/HEAD)
1414

1515
## Conda
16+
Running the tutorials requires AMD Vitis HLS to be installed, see [here](https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vitis.html).
17+
After the installation, the necessary environmental variables can be set using
18+
```
19+
source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh
20+
```
21+
1622
The Python environment used for the tutorials is specified in the `environment.yml` file.
1723
It can be setup like:
1824
```bash
1925
conda env create -f environment.yml
2026
conda activate hls4ml-tutorial
27+
source /path/to/your/installtion/Xilinx/Vitis_HLS/202X.X/settings64.(c)sh
2128
```
2229

23-
## Docker without Vivado
24-
Pull the prebuilt image from the GitHub Container Registry:
25-
```bash
26-
docker pull ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest
27-
```
28-
29-
Follow these steps to build a Docker image that can be used locally, or on a JupyterHub instance.
30-
You can build the image (without Vivado):
31-
```bash
32-
docker build https://github.com/fastmachinelearning/hls4ml-tutorial -f docker/Dockerfile
33-
```
34-
Alternatively, you can clone the repository and build locally:
35-
```bash
36-
git clone https://github.com/fastmachinelearning/hls4ml-tutorial
37-
cd hls4ml-tutorial
38-
docker build -f docker/Dockerfile -t ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest .
39-
```
40-
Then to start the container:
41-
```bash
42-
docker run -p 8888:8888 ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0:latest
43-
```
44-
When the container starts, the Jupyter notebook server is started, and the link to open it in your browser is printed.
45-
You can clone the repository inside the container and run the notebooks.
46-
47-
## Docker with Vivado
48-
Pull the prebuilt image from the GitHub Container Registry:
49-
```bash
50-
docker pull ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest
51-
```
52-
53-
To build the image with Vivado, run (Warning: takes a long time and requires a lot of disk space):
54-
```bash
55-
docker build -f docker/Dockerfile.vivado -t ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest .
56-
```
57-
Then to start the container:
58-
```bash
59-
docker run -p 8888:8888 ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.8.0-vivado-2019.2:latest
60-
```
30+
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](https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/archive.html).
6131

6232
## Companion material
6333
We have prepared a set of slides with some introduction and more details on each of the exercises.

docker/Dockerfile

Lines changed: 0 additions & 40 deletions
This file was deleted.

docker/Dockerfile.vivado

Lines changed: 0 additions & 48 deletions
This file was deleted.

docker/install_vivado.sh

Lines changed: 0 additions & 33 deletions
This file was deleted.

docker/start-notebook.sh

Lines changed: 0 additions & 25 deletions
This file was deleted.

docker/vivado_cfg.txt

Lines changed: 0 additions & 30 deletions
This file was deleted.

environment.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ name: hls4ml-tutorial
22
channels:
33
- conda-forge
44
dependencies:
5-
- python=3.10.10
6-
- jupyter_contrib_nbextensions==0.7.0
7-
- jupyterhub==3.1.1
8-
- jupyter-book==0.15.1
5+
- python=3.10.16
6+
- jupyter_contrib_nbextensions
7+
- jupyterhub
8+
- jupyter-book
99
- jsonschema-with-format-nongpl
1010
- pydot==1.4.2
1111
- graphviz==7.1.0
1212
- scikit-learn==1.2.2
13-
- tensorflow==2.11.1
13+
- tensorflow==2.14.0
1414
- tensorflow-datasets==4.8.3
1515
- webcolors
1616
- widgetsnbextension==3.6.0
1717
- pip==23.0.1
1818
- pip:
19-
- hls4ml[profiling]==0.8.0
20-
- qkeras==0.9.0
21-
- conifer==0.2b0
19+
- hls4ml[profiling,optimization,sr,HGQ]==1.0.0
20+
- conifer==1.5
2221
- pysr==0.16.3
22+
- xgboost==1.7.5

images/part5_floorplan.png

539 KB
Loading

0 commit comments

Comments
 (0)