This release is a pre-release and may not be stable for production use.
A package for machine learning inference in FPGAs. We create firmware implementations of machine learning algorithms using high level synthesis language (HLS). We translate traditional open-source machine learning package models into HLS that can be configured for your use-case!
Contact: hls4ml.help@gmail.com
Documentation & Tutorial
For more information visit the webpage: https://fastmachinelearning.org/hls4ml/
Detailed tutorials on how to use hls4ml's various functionalities can be found here.
Installation
pip install hls4ml
To install the extra dependencies for profiling:
pip install hls4ml[profiling]
Getting Started
Creating an HLS project
import hls4ml
#Fetch a keras model from our example repository
#This will download our example model to your working directory and return an example configuration file
config = hls4ml.utils.fetch_example_model('KERAS_3layer.json')
print(config) #You can print the configuration to see some default parameters
#Convert it to a hls project
hls_model = hls4ml.converters.keras_to_hls(config)
# Print full list of example models if you want to explore more
hls4ml.utils.fetch_example_list()
Building a project with Xilinx Vitis (after downloading and installing from here)
#Use Vivado HLS to synthesize the model
#This might take several minutes
hls_model.build()
#Print out the report if you want
hls4ml.report.read_vivado_report('my-hls-test')
Metadata
Release files for hls4ml 0.5.0b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hls4ml-0.5.0b0.tar.gz | 247.7 kB | Without provenance | Details for hls4ml-0.5.0b0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hls4ml-0.5.0b0-py3-none-any.whl | Python 3 | none | any | Details for hls4ml-0.5.0b0-py3-none-any.whl |
Total release size: 500.9 kB
Release files / hls4ml-0.5.0b0.tar.gz
| Download URL | hls4ml-0.5.0b0.tar.gz |
|---|---|
| Size | 247.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9274b55ba055542c83ad95dad71bc0c4c372a8d2b74f08fca1707fd5082b7479
|
|
BLAKE2b-256 checksum How to use checksums |
29f5c3ee8135950055548a441cee5627b63e652ad64c6a01c5c4c1b5652d2900
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9
|
Release files / hls4ml-0.5.0b0-py3-none-any.whl
| Download URL | hls4ml-0.5.0b0-py3-none-any.whl |
|---|---|
| Size | 253.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b259f36192705a30e1e9919f07e9d8b214d603985a1e9f7daec4ac2d5976dea
|
|
BLAKE2b-256 checksum How to use checksums |
4dded70c4990fb6361f21d6239299b2534a54441fc6260ab7a78e12204cbe670
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9
|
Security for hls4ml 0.5.0b0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.