From 0c16f8d09fe36796321c78e043acca6d26023724 Mon Sep 17 00:00:00 2001 From: Javier Duarte Date: Wed, 20 Jul 2022 12:06:44 -0700 Subject: [PATCH 1/4] Update README.md --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/README.md b/README.md index f3d501763..19c147b61 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,67 @@ hls_model.build() #Print out the report if you want hls4ml.report.read_vivado_report('my-hls-test') ``` + +# Citation +If you use this software in a publication, please cite the software +```bibtex +@software{vloncar_2021_5680908, + author = {Loncar, Vladimir and others}, + title = {fastmachinelearning/hls4ml: coris}, + year = 2021, + publisher = {Zenodo}, + version = {v0.6.0}, + doi = {10.5281/zenodo.5680908}, + url = {https://github.com/fastmachinelearning/hls4ml} +} +``` +and first publication: +```bibtex +@article{Duarte:2018ite, + author = "Duarte, Javier and others", + title = "{Fast inference of deep neural networks in FPGAs for particle physics}", + eprint = "1804.06913", + archivePrefix = "arXiv", + primaryClass = "physics.ins-det", + reportNumber = "FERMILAB-PUB-18-089-E", + doi = "10.1088/1748-0221/13/07/P07027", + journal = "JINST", + volume = "13", + number = "07", + pages = "P07027", + year = "2018" +} +``` +Additionally, if you use specific features developed in later papers, please cite those as well. For example, CNNs: +```bibtex +@article{Aarrestad:2021zos, + author = "Aarrestad, Thea and others", + title = "{Fast convolutional neural networks on FPGAs with hls4ml}", + eprint = "2101.05108", + archivePrefix = "arXiv", + primaryClass = "cs.LG", + reportNumber = "FERMILAB-PUB-21-130-SCD", + doi = "10.1088/2632-2153/ac0ea1", + journal = "Mach. Learn. Sci. Tech.", + volume = "2", + number = "4", + pages = "045015", + year = "2021" +} +``` +binary/ternary networks: +```bibtex +@article{Loncar:2020hqp, + author = "Ngadiuba, Jennifer and others", + title = "{Compressing deep neural networks on FPGAs to binary and ternary precision with HLS4ML}", + eprint = "2003.06308", + archivePrefix = "arXiv", + primaryClass = "cs.LG", + reportNumber = "FERMILAB-PUB-20-167-PPD-SCD", + doi = "10.1088/2632-2153/aba042", + journal = "Mach. Learn. Sci. Tech.", + volume = "2", + pages = "015001", + year = "2021" +} +``` From 640f961760cf63f6e7048bf02a6bc1b644707ab2 Mon Sep 17 00:00:00 2001 From: Javier Duarte Date: Thu, 27 Oct 2022 08:45:33 -0700 Subject: [PATCH 2/4] update docs --- docs/index.rst | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index f56f23d6e..4f63d9f80 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,3 +47,75 @@ Tutorials Detailed tutorials on how to use ``hls4ml``'s various functionalities can be found at: https://github.com/fastmachinelearning/hls4ml-tutorial + +Citation +================================= +If you use this software in a publication, please cite the software + +.. code-block:: bibtex + + @software{vloncar_2021_5680908, + author = {Loncar, Vladimir and others}, + title = {fastmachinelearning/hls4ml: coris}, + year = 2021, + publisher = {Zenodo}, + version = {v0.6.0}, + doi = {10.5281/zenodo.5680908}, + url = {https://github.com/fastmachinelearning/hls4ml} + } + +and first publication: + +.. code-block:: bibtex + + @article{Duarte:2018ite, + author = "Duarte, Javier and others", + title = "{Fast inference of deep neural networks in FPGAs for particle physics}", + eprint = "1804.06913", + archivePrefix = "arXiv", + primaryClass = "physics.ins-det", + reportNumber = "FERMILAB-PUB-18-089-E", + doi = "10.1088/1748-0221/13/07/P07027", + journal = "JINST", + volume = "13", + number = "07", + pages = "P07027", + year = "2018" + } + +Additionally, if you use specific features developed in later papers, please cite those as well. For example, CNNs: + +.. code-block:: bibtex + + @article{Aarrestad:2021zos, + author = "Aarrestad, Thea and others", + title = "{Fast convolutional neural networks on FPGAs with hls4ml}", + eprint = "2101.05108", + archivePrefix = "arXiv", + primaryClass = "cs.LG", + reportNumber = "FERMILAB-PUB-21-130-SCD", + doi = "10.1088/2632-2153/ac0ea1", + journal = "Mach. Learn. Sci. Tech.", + volume = "2", + number = "4", + pages = "045015", + year = "2021" + } + +binary/ternary networks: + +.. code-block:: bibtex + + @article{Loncar:2020hqp, + author = "Ngadiuba, Jennifer and others", + title = "{Compressing deep neural networks on FPGAs to binary and ternary precision with HLS4ML}", + eprint = "2003.06308", + archivePrefix = "arXiv", + primaryClass = "cs.LG", + reportNumber = "FERMILAB-PUB-20-167-PPD-SCD", + doi = "10.1088/2632-2153/aba042", + journal = "Mach. Learn. Sci. Tech.", + volume = "2", + pages = "015001", + year = "2021" + } From dfdffb4326dc6c696cd1d2d9bac2763b1d6de973 Mon Sep 17 00:00:00 2001 From: Javier Duarte Date: Thu, 27 Oct 2022 12:53:45 -0700 Subject: [PATCH 3/4] update --- CITATION.cff | 23 +++++++++++++++++++++++ README.md | 18 ++++++++++++++---- docs/index.rst | 18 ++++++++++++++---- 3 files changed, 51 insertions(+), 8 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..3d9248cae --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,23 @@ +cff-version: 1.2.0 +message: "Please cite the following works when using this software." +type: software +authors: +- given-names: "FastML Team" +title: "hls4ml" +doi: 10.5281/zenodo.1201549 +repository-code: "https://github.com/fastmachinelearning/hls4ml" +url: "https://fastmachinelearning.org/hls4ml" +keywords: + - python + - machine-learning + - FPGA + - physics + - tensorflow + - pytorch + - onnx + - qonnx +license: "Apache-2.0" +abstract: | + hls4ml is an open-source software-hardware codesign workflow + to interpret and translate machine learning algorithms for + implementations in hardware, including FPGAs and ASICs. diff --git a/README.md b/README.md index 19c147b61..167a0d261 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,11 @@ hls4ml.report.read_vivado_report('my-hls-test') If you use this software in a publication, please cite the software ```bibtex @software{vloncar_2021_5680908, - author = {Loncar, Vladimir and others}, - title = {fastmachinelearning/hls4ml: coris}, + author = {{FastML Team}}, + title = {fastmacheinelearning/hls4ml}, year = 2021, publisher = {Zenodo}, - version = {v0.6.0}, - doi = {10.5281/zenodo.5680908}, + doi = {10.5281/zenodo.1201549}, url = {https://github.com/fastmachinelearning/hls4ml} } ``` @@ -103,6 +102,17 @@ Additionally, if you use specific features developed in later papers, please cit pages = "045015", year = "2021" } +@article{Ghielmetti:2022ndm, + author = "Ghielmetti, Nicol\`{o} and others", + title = "{Real-time semantic segmentation on FPGAs for autonomous vehicles with hls4ml}", + eprint = "2205.07690", + archivePrefix = "arXiv", + primaryClass = "cs.CV", + reportNumber = "FERMILAB-PUB-22-435-PPD", + doi = "10.1088/2632-2153/ac9cb5", + journal ="Mach. Learn. Sci. Tech.", + year = "2022" +} ``` binary/ternary networks: ```bibtex diff --git a/docs/index.rst b/docs/index.rst index 4f63d9f80..da7e44534 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -55,12 +55,11 @@ If you use this software in a publication, please cite the software .. code-block:: bibtex @software{vloncar_2021_5680908, - author = {Loncar, Vladimir and others}, - title = {fastmachinelearning/hls4ml: coris}, + author = {{FastML Team}}, + title = {fastmachinelearning/hls4ml}, year = 2021, publisher = {Zenodo}, - version = {v0.6.0}, - doi = {10.5281/zenodo.5680908}, + doi = {10.5281/zenodo.1201549}, url = {https://github.com/fastmachinelearning/hls4ml} } @@ -101,6 +100,17 @@ Additionally, if you use specific features developed in later papers, please cit pages = "045015", year = "2021" } + @article{Ghielmetti:2022ndm, + author = "Ghielmetti, Nicol\`{o} and others", + title = "{Real-time semantic segmentation on FPGAs for autonomous vehicles with hls4ml}", + eprint = "2205.07690", + archivePrefix = "arXiv", + primaryClass = "cs.CV", + reportNumber = "FERMILAB-PUB-22-435-PPD", + doi = "10.1088/2632-2153/ac9cb5", + journal ="Mach. Learn. Sci. Tech.", + year = "2022" + } binary/ternary networks: From a924cc8a4576bb872854a4d32b7d620e5d5766f2 Mon Sep 17 00:00:00 2001 From: Javier Duarte Date: Thu, 27 Oct 2022 12:56:27 -0700 Subject: [PATCH 4/4] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 167a0d261..e1bbdc121 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ If you use this software in a publication, please cite the software ```bibtex @software{vloncar_2021_5680908, author = {{FastML Team}}, - title = {fastmacheinelearning/hls4ml}, + title = {fastmachinelearning/hls4ml}, year = 2021, publisher = {Zenodo}, doi = {10.5281/zenodo.1201549},