Does hls4ml work on Windows?

[janarbek]

Hi All,

I have seen that it is not supported on Windows, but wanted to verify if hls4ml works on Windows? Anyone tried? What it takes to make it run on Windows?

[vloncar]

Compilation of projects for simulation (model.compile(), model.predict() etc) fails due to compiler not being available and setting up an environment for it via Cygwin/MingW is cumbersome to support. Furthermore the generated HLS project doesn't compile with Vivado HLS tools due to issues in their toolchain. We didn't try the more recent Vitis HLS. It is unlikely we will support Windows in any official way since none of the developers use it. You can use WSL to setup Linux within windows where hls4ml works as expected, but you may still run into issues with synthesis if you use Windows installation of Vivado/Vitis

[janarbek]

Hii Vladimir, I have seen a recent tutorial from here: https://nssmic.ieee.org/2023/program/ I am not sure if this tutorial is given to your group, but I was under the impression that we can use Windows (in the prerequisite of the tutorial it is listed that Windows or linux is needed? If we can use Windows, that would be great -- any help or resources will be appreciated. Thanks, J.

…

On Thu, Oct 26, 2023 at 4:14 AM Vladimir ***@***.***> wrote: Compilation of projects for simulation (model.compile(), model.predict() etc) fails due to compiler not being available and setting up an environment for it via Cygwin/MingW is cumbersome to support. Furthermore the generated HLS project doesn't compile with Vivado HLS tools due to issues in their toolchain. We didn't try the more recent Vitis HLS. It is unlikely we will support Windows in any official way since none of the developers use it. You can use WSL to setup Linux within windows where hls4ml works as expected, but you may still run into issues with synthesis if you use Windows installation of Vivado/Vitis — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml/discussions/899*discussioncomment-7391564__;Iw!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzzrJw64tA$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAUAOPUYLMHT6Y6GGGGV5LTYBJAYZAVCNFSM6AAAAAA6QMNCEKVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TGOJRGU3DI__;!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzyYkybXpA$> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>

[jmitrevs]

The tutorial is done on the cloud so the computer doesn’t matter. Jovan On Nov 1, 2023, at 19:57, janarbek ***@***.***> wrote: Hii Vladimir, I have seen a recent tutorial from here: https://nssmic.ieee.org/2023/program/ I am not sure if this tutorial is given to your group, but I was under the impression that we can use Windows (in the prerequisite of the tutorial it is listed that Windows or linux is needed? If we can use Windows, that would be great -- any help or resources will be appreciated. Thanks, J.

On Thu, Oct 26, 2023 at 4:14 AM Vladimir ***@***.***> wrote: Compilation of projects for simulation (model.compile(), model.predict() etc) fails due to compiler not being available and setting up an environment for it via Cygwin/MingW is cumbersome to support. Furthermore the generated HLS project doesn't compile with Vivado HLS tools due to issues in their toolchain. We didn't try the more recent Vitis HLS. It is unlikely we will support Windows in any official way since none of the developers use it. You can use WSL to setup Linux within windows where hls4ml works as expected, but you may still run into issues with synthesis if you use Windows installation of Vivado/Vitis — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml/discussions/899*discussioncomment-7391564__;Iw!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzzrJw64tA$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAUAOPUYLMHT6Y6GGGGV5LTYBJAYZAVCNFSM6AAAAAA6QMNCEKVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TGOJRGU3DI__;!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzyYkybXpA$> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[janarbek]

Thank you for the prompt response, now I understand. I am wondering if we can access the tutorial on the cloud? I tried to use the link (https://tutorials.fastmachinelearning.org/), but it does not work. Thanks, J. On Wed, Nov 1, 2023 at 8:23 PM Jovan Mitrevski ***@***.***> wrote:

…

The tutorial is done on the cloud so the computer doesn’t matter. Jovan On Nov 1, 2023, at 19:57, janarbek ***@***.***> wrote: Hii Vladimir, I have seen a recent tutorial from here: https://nssmic.ieee.org/2023/program/ <https://urldefense.com/v3/__https://nssmic.ieee.org/2023/program/__;!!Mih3wA!BMblxHGB9Rb1_C7VwOLe_NlXNfw2Koe4CkHm3-UokDayKh5x2ZXlGAQ8E_OyiS4fQGJeKbl_66z8MLoYaPGeDll3lw$> I am not sure if this tutorial is given to your group, but I was under the impression that we can use Windows (in the prerequisite of the tutorial it is listed that Windows or linux is needed? If we can use Windows, that would be great -- any help or resources will be appreciated. Thanks, J. On Thu, Oct 26, 2023 at 4:14 AM Vladimir ***@***.***> wrote: > Compilation of projects for simulation (model.compile(), model.predict() > etc) fails due to compiler not being available and setting up an > environment for it via Cygwin/MingW is cumbersome to support. Furthermore > the generated HLS project doesn't compile with Vivado HLS tools due to > issues in their toolchain. We didn't try the more recent Vitis HLS. It is > unlikely we will support Windows in any official way since none of the > developers use it. You can use WSL to setup Linux within windows where > hls4ml works as expected, but you may still run into issues with synthesis > if you use Windows installation of Vivado/Vitis > > — > Reply to this email directly, view it on GitHub > < https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml/discussions/899*discussioncomment-7391564__;Iw!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzzrJw64tA$%3E, > or unsubscribe > < https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAUAOPUYLMHT6Y6GGGGV5LTYBJAYZAVCNFSM6AAAAAA6QMNCEKVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TGOJRGU3DI__;!!Mih3wA!CZCuBUHzMUV9B_szY-u8ecJl-9ErKuGdHaSFqWoUH_KHPADW_c9aejD83BZheYL-1LKx2cmV_0QjcPQIEzyYkybXpA$%3E > . > You are receiving this because you authored the thread.Message ID: > ***@***.*** > com> > —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml/discussions/899*discussioncomment-7452046__;Iw!!Mih3wA!BMblxHGB9Rb1_C7VwOLe_NlXNfw2Koe4CkHm3-UokDayKh5x2ZXlGAQ8E_OyiS4fQGJeKbl_66z8MLoYaPGWtQoZLA$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAUAOPRRTBEE4GFUQQPUFG3YCMG3DAVCNFSM6AAAAAA6QMNCEKVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TINJSGA2DM__;!!Mih3wA!BMblxHGB9Rb1_C7VwOLe_NlXNfw2Koe4CkHm3-UokDayKh5x2ZXlGAQ8E_OyiS4fQGJeKbl_66z8MLoYaPGQrMOjpw$> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>

[vloncar]

I believe that link is working during the tutorial, we don't spin up cloud resources to be idle outside of the tutorials. Just to clarify, only one step of the flow from the model to hardware doesn't work on windows, the C++ compilation that is part of simulation and C synthesis. Once you have the bitfile produced you can move to your platform of choice, which is what I think is done in hands-on with the Pynq board.

Perhaps the organizers, @elhamekhoda and @ben-hawks can elaborate?

[ben-hawks]

Hi @janarbek! @vloncar is correct, all the compilation itself is done in the cloud instance for the tutorial, then the final files are moved over to the board via Jupyerhub, scp, etc. to further run locally on the Pynq-Z2.

The course requirements (windows or linux) are primarily so that if something happens, it's possible to debug/program the hardware with what the student has.

If you're interested in trying to run/access the tutorial material outside of the course, it's available in a docker container (with or without Vivado) you can deploy where convenient: https://github.com/fastmachinelearning/hls4ml-tutorial/tree/main#docker-with-vivado

[janarbek]

Hi Ben, So I used WSL 2 and docker to run the docker image. I was able to set up everything successfully -- and now I am in the last stage where I have some questions. When I run the following command, I am getting the screen shown below. I opened the jupyter notebook, but I do not see the examples (part 1- part 4) as suggested by tutorial slides. docker run -p 8888:8888 ghcr.io/fastmachinelearning/hls4ml-tutorial/hls4ml-0.7.1-vivado-2019.2:latest This is what I see after running the docker. [image: image.png] This is what jupyter notebook looks like. So my question is where are the example files (part 1 to part4)? [image: image.png]

…

On Thu, Nov 2, 2023 at 12:03 PM Ben Hawks ***@***.***> wrote: Hi @janarbek <https://urldefense.com/v3/__https://github.com/janarbek__;!!Mih3wA!Hb1NQzV74xOzoBAYsgx4gJ304CHMJT5OOsoNdOD6PZlpeKDvLJggw3utwDCG4CjikWjpfCCEG7uQsFgxZovSFupu5w$>! @vloncar <https://urldefense.com/v3/__https://github.com/vloncar__;!!Mih3wA!Hb1NQzV74xOzoBAYsgx4gJ304CHMJT5OOsoNdOD6PZlpeKDvLJggw3utwDCG4CjikWjpfCCEG7uQsFgxZosO9KTKow$> is correct, all the compilation itself is done in the cloud instance for the tutorial, then the final files are moved over to the board via Jupyerhub, scp, etc. to further run locally on the Pynq-Z2. The course requirements (windows or linux) are primarily so that if something happens, it's possible to debug/program the hardware with what the student has. If you're interested in trying to run/access the tutorial material outside of the course, it's available in a docker container (with or without Vivado) you can deploy where convenient: https://github.com/fastmachinelearning/hls4ml-tutorial/tree/main#docker-with-vivado <https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml-tutorial/tree/main*docker-with-vivado__;Iw!!Mih3wA!Hb1NQzV74xOzoBAYsgx4gJ304CHMJT5OOsoNdOD6PZlpeKDvLJggw3utwDCG4CjikWjpfCCEG7uQsFgxZovLDKZOaQ$> — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/fastmachinelearning/hls4ml/discussions/899*discussioncomment-7460277__;Iw!!Mih3wA!Hb1NQzV74xOzoBAYsgx4gJ304CHMJT5OOsoNdOD6PZlpeKDvLJggw3utwDCG4CjikWjpfCCEG7uQsFgxZousQdevZw$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAUAOPU34HE5UYOVF5747LTYCPU6ZAVCNFSM6AAAAAA6QMNCEKVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TINRQGI3TO__;!!Mih3wA!Hb1NQzV74xOzoBAYsgx4gJ304CHMJT5OOsoNdOD6PZlpeKDvLJggw3utwDCG4CjikWjpfCCEG7uQsFgxZosQughELg$> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>