{"id":16392448,"url":"https://github.com/jmduarte/hls_hls4ml_tutorial","last_synced_at":"2025-09-11T20:33:30.677Z","repository":{"id":67784042,"uuid":"277939253","full_name":"jmduarte/HLS_hls4ml_Tutorial","owner":"jmduarte","description":"HLS \u0026 hls4ml Tutorial","archived":false,"fork":false,"pushed_at":"2020-08-05T16:34:43.000Z","size":17694,"stargazers_count":10,"open_issues_count":0,"forks_count":6,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-01-02T10:44:53.524Z","etag":null,"topics":["fpga","fpga-firmware","fpga-programming","high-energy-physics","high-level-synthesis","hls","hls4ml","machine-learning","particle-physics","vitis","vivado","vivado-hls","xilinx","xilinx-fpga"],"latest_commit_sha":null,"homepage":"https://fastmachinelearning.org/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jmduarte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-07T22:59:09.000Z","updated_at":"2024-12-23T11:57:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"463a2056-3a55-4d1e-9040-481aef5ad874","html_url":"https://github.com/jmduarte/HLS_hls4ml_Tutorial","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmduarte%2FHLS_hls4ml_Tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmduarte%2FHLS_hls4ml_Tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmduarte%2FHLS_hls4ml_Tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmduarte%2FHLS_hls4ml_Tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmduarte","download_url":"https://codeload.github.com/jmduarte/HLS_hls4ml_Tutorial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232666175,"owners_count":18557991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fpga","fpga-firmware","fpga-programming","high-energy-physics","high-level-synthesis","hls","hls4ml","machine-learning","particle-physics","vitis","vivado","vivado-hls","xilinx","xilinx-fpga"],"created_at":"2024-10-11T04:49:54.986Z","updated_at":"2025-01-06T02:57:56.704Z","avatar_url":"https://github.com/jmduarte.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HLS \u0026 `hls4ml` Tutorial\n\n- Original files can be downloaded from Xilinx (after agreeing to license) here: [ug871-design-files.zip](https://www.xilinx.com/cgi-bin/docs/ctdoc?cid=026f56e2-0a0f-4986-aeb7-e92917398939;d=ug871-design-files.zip)\n- Xilinx Vivado HLS Guide: [ug871-vivado-high-level-synthesis-tutorial.pdf](ug871-vivado-high-level-synthesis-tutorial.pdf)\n\n## Software Requirements\n\n- Vivado/Vitis Design Suite 2017.1 or later release (and source `/PATH/TO/Vivado/20XX.X/settings64.sh` with correct path/version)\n- Miniconda (can be downloaded from https://docs.conda.io/en/latest/miniconda.html)\n- Once Miniconda is installed and setup, create the conda environment with `hls4ml` and `qkeras`:\n```\nconda env create -f environment.yml\n```\n- The setup to make a Jupyter kernel with the Xilinx libraries is (assuming Vivado is already set up / sourced)\n```\npython setup_kernel.py\n```\n\n## Labs\n\n1. [Introduction to HLS Lab 1](Introduction/lab1/README.md)\n1. [Introduction to HLS Lab 2](Introduction/lab2/README.md)\n1. [Pipelining Lab 1](Design_Optimization/lab1/README.md)\n1. [Pipelining Lab 2](Design_Optimization/lab2/README.md)\n1. [hls4ml Lab](hls4ml/lab1/README.md)\n1. [hls4ml+QKeras Lab](hls4ml/lab2/README.md)\n\n## Other Resources \n\n- Parallel Programming for FPGAs (HLS Book): http://kastner.ucsd.edu/hlsbook/\n- HLS Book Labs: https://pp4fpgas.readthedocs.io/en/latest/index.html\n- UCSD CSE 237C: http://kastner.ucsd.edu/ryan/cse237c/\n- `hls4ml` tutorial at Fast ML workshop: https://github.com/FPGA4HEP/course_material/tree/fml\n- `QKeras` in `hls4ml`: https://indico.cern.ch/event/919468/contributions/3863588/attachments/2039929/3416087/sps_qkeras.pdf\n- `QKeras` and `hls4ml` API functionality notebook: https://gist.github.com/thesps/c7e59cf5597804693b8663ddc9496b64\n- `QKeras` and `hls4ml` API PR: https://github.com/hls-fpga-machine-learning/hls4ml/pull/195\n- \"Official\" `hls4ml` tutorial: https://github.com/hls-fpga-machine-learning/hls4ml-tutorial\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmduarte%2Fhls_hls4ml_tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmduarte%2Fhls_hls4ml_tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmduarte%2Fhls_hls4ml_tutorial/lists"}