hls4ml.report package
Submodules
hls4ml.report.catapult_report module
- hls4ml.report.catapult_report.get_latest_project_prj_directory(base_path, ProjectDir)
- hls4ml.report.catapult_report.get_latest_project_version_directory(base_path, ProjectName)
- hls4ml.report.catapult_report.parse_catapult_report(output_dir)
- hls4ml.report.catapult_report.qofr(report)
- hls4ml.report.catapult_report.read_catapult_report(hls_dir, full_report=False)
hls4ml.report.oneapi_report module
- hls4ml.report.oneapi_report.parse_oneapi_report(hls_dir)
Parse a report from a given oneAPI project as a dictionary.
- Parameters:
hls_dir (string) – The directory where the project is found
- Returns:
The report dictionary, containing latency, resource usage etc.
- Return type:
results (dict)
- hls4ml.report.oneapi_report.print_oneapi_report(report_dict)
Prints the oneAPI report dictionary as a table.
- Parameters:
report_dict (dictionary) – The report dictionary, containing latency, resource usage etc.
- Returns:
None
hls4ml.report.quartus_report module
- hls4ml.report.quartus_report.parse_quartus_report(hls_dir, write_to_file=True)
Parse a report from a given Quartus project as a dictionary.
- Parameters:
hls_dir (string) – The directory where the project is found
write_to_file (bool) – A flag indicating whether to write the results to a separate file
- Returns:
The report dictionary, containing latency, resource usage etc.
- Return type:
results (dict)
- hls4ml.report.quartus_report.read_js_object(js_script)
Reads the JavaScript file and return a dictionary of variables definded in the script.
- Parameters:
js_script (string)
- Returns:
Dictionary of variables defines in script
- hls4ml.report.quartus_report.read_quartus_report(hls_dir, open_browser=False)
Parse and print the Quartus report to print the report. Optionally open a browser.
- Parameters:
hls_dir (string) – The directory where the project is found
open_browser – whether to open a browser
optional – whether to open a browser
- Returns:
None
hls4ml.report.vivado_report module
- hls4ml.report.vivado_report.parse_vivado_report(hls_dir)
- hls4ml.report.vivado_report.print_vivado_report(report_dict)
- hls4ml.report.vivado_report.read_vivado_report(hls_dir, full_report=False)