一个用于在FPGA上进行机器学习推理的软件包。我们使用高层次综合语言（HLS）创建机器学习算法的固件实现。我们将传统的开源机器学习模型转换为可针对您的用例进行配置的HLS代码！

hls4ml专为FPGA上的超低延迟推理而设计。尽管它在高能物理应用领域（例如，欧洲核子研究中心大型强子对撞机的L1触发系统）有着深厚的基础，但也已被广泛应用于各种科学和工业领域。其典型应用场景包括量子计算控制系统、核聚变反馈回路、卫星上的低功耗环境监测以及生物医学信号处理（如心律失常分类）等。

如果您对hls4ml有任何疑问、意见或想法，或者只是想与我们分享您如何使用hls4ml，请随时通过讨论区与我们联系。

文档与教程

更多信息请访问官网：https://fastmachinelearning.org/hls4ml/。

有关FPGA、HLS以及使用hls4ml进行ML推理的入门资料，请观看视频。

关于如何使用hls4ml各项功能的详细教程，请参阅这里。

安装

pip install hls4ml

若需安装用于性能分析的额外依赖项：

pip install hls4ml[profiling]

快速开始

创建一个HLS项目

import hls4ml

# 从我们的示例仓库中获取一个Keras模型
# 这将下载我们的示例模型到您的工作目录，并返回一个示例配置文件
config = hls4ml.utils.fetch_example_model('KERAS_3layer.json')

# 您可以打印配置以查看一些默认参数
print(config)

# 将其转换为HLS项目
hls_model = hls4ml.converters.keras_v2_to_hls(config)

# 如果您想进一步探索，可以打印所有示例模型的列表
hls4ml.utils.fetch_example_list()

构建项目。

我们将使用Xilinx Vivado HLS来构建该项目，您可以从这里下载并安装。除了Vivado HLS之外，hls4ml还支持Vitis HLS、Intel HLS、Catapult HLS，并对Intel oneAPI提供了一些实验性支持。您可以在构建模型时通过backend参数更改目标后端。

# 使用Vivado HLS合成模型
# 这可能需要几分钟时间
hls_model.build()

# 如果需要，可以打印报告
hls4ml.report.read_vivado_report('my-hls-test')

常见问题解答

常见问题及常见的HLS综合问题列表请参见这里。

引用

如果您在论文或其他出版物中使用本软件，请引用以下内容：

@software{fastml_hls4ml,
  author       = {{FastML Team}},
  title        = {fastmachinelearning/hls4ml},
  year         = 2025,
  publisher    = {Zenodo},
  version      = {v1.3.0},
  doi          = {10.5281/zenodo.1201549},
  url          = {https://github.com/fastmachinelearning/hls4ml}
}

首次发表的相关论文：

@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"
}

以及最新的综述论文：

@article{Schulte:2025mai,
    author = "Schulte, Jan-Frederik and others",
    title = "{hls4ml: A Flexible, Open-Source Platform for Deep Learning Acceleration on Reconfigurable Hardware}",
    eprint = "2512.01463",
    archivePrefix = "arXiv",
    primaryClass = "cs.AR",
    reportNumber = "FERMILAB-PUB-25-0890-CSAID-ETD-PPD",
    month = "12",
    year = "2025"
}

此外，如果您使用了后期论文中开发的特定功能，也请一并引用。例如，关于卷积神经网络的论文：

@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"
}
@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"
}

关于分布式算术的论文：

@misc{Sun:2025,
      title={da4ml: Distributed Arithmetic for Real-time Neural Networks on FPGAs},
      author={Chang Sun and others},
      year={2025},
      eprint={2507.04535},
      archivePrefix={arXiv},
      primaryClass={cs.AR},
      url={https://arxiv.org/abs/2507.04535},
}

关于二值化/三值化网络的论文：

@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"
}

致谢

如果您从参与我们的社区中受益，我们恳请您在任何出版物中注明 Fast Machine Learning 合作团队，以及特别帮助过您的个人。 请使用以下文字进行致谢：

我们感谢 Fast Machine Learning 团队作为一个由多领域专家和合作者组成的开放社区。该社区以及<个人姓名>，尤其是他们，对本项目的开发起到了重要作用。

资助

我们衷心感谢美国国家科学基金会（NSF）“数据革命赋能”（HDR）研究所下“加速面向数据驱动发现的人工智能算法”（A3D3）项目在合作协议编号PHY-2117997下的支持；感谢美国能源部科学办公室高级科学计算研究处，在“面向科学的极端边缘实时数据压缩协同设计”（XDR）项目（DE-FOA-0002501）中的资助；感谢美国能源部科学办公室高能物理早期职业研究计划（DE-SC0021187, DE-0000247070）的支持；感谢欧洲研究理事会（ERC）在欧盟“地平线2020”研究与创新计划框架下提供的资助（ grant No. 772369）；以及感谢埃里克与温迪·施密特战略创新基金通过 CERN 下一代触发器项目，在资助协议编号 SIF-2023-004 下提供的支持。

hls4ml 快速上手指南

hls4ml 是一个用于在 FPGA 上进行机器学习推理的开源工具包。它能够将主流的机器学习模型（如 Keras/TensorFlow）转换为高层次综合（HLS）代码，从而实现超低延迟的硬件加速推理。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：推荐 Linux (Ubuntu/CentOS) 或 macOS。Windows 用户建议使用 WSL2。
• Python 版本：Python 3.8 或更高版本。
• HLS 编译器（必需）：
  • Xilinx Vivado HLS 或 Vitis HLS（最常用，需单独下载安装）。
  • 也支持 Intel HLS Compiler、Catapult HLS 等后端。
  • 注意：hls4ml 本身不包含 HLS 编译器，请务必先从厂商官网安装相应工具并配置好环境变量。
• 基础依赖：pip, git, cmake (部分功能需要)。

2. 安装步骤

标准安装

使用 pip 直接安装最新稳定版：

pip install hls4ml

安装额外功能（可选）

如果您需要使用性能分析（profiling）功能，请安装额外依赖：

pip install hls4ml[profiling]

提示：国内用户若遇到下载速度慢的问题，可使用清华源或阿里源加速安装：

pip install hls4ml -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 基本使用

以下是最简单的快速入门流程，演示如何获取一个示例模型并将其转换为 HLS 项目。

第一步：转换模型

运行以下 Python 代码，它将自动下载一个示例 Keras 模型配置文件，并将其转换为 hls4ml 项目结构。

import hls4ml

# 获取示例模型配置 (会自动下载到当前目录)
config = hls4ml.utils.fetch_example_model('KERAS_3layer.json')

# 查看默认配置参数
print(config)

# 将 Keras 模型转换为 HLS 项目
hls_model = hls4ml.converters.keras_v2_to_hls(config)

# (可选) 查看所有可用的示例模型列表
# hls4ml.utils.fetch_example_list()

第二步：构建与综合

调用 .build() 方法将启动后端的 HLS 编译器（默认为 Vivado HLS）进行代码综合。此过程可能需要几分钟。

# 使用已安装的 HLS 工具链综合模型
# 确保已在系统环境变量中配置好 vivado_hls 或 vitis_hls
hls_model.build()

# 读取并打印综合报告 (以 Vivado 为例)
hls4ml.report.read_vivado_report('my-hls-test')

构建完成后，您可以在生成的目录中找到可综合的 C++ 代码、测试台以及资源利用率报告。您可以进一步修改配置（如量化精度、流水线策略等）以优化 FPGA 资源消耗和延迟。