Skip to content

print_vivado_report function for nicer reports

Javier Duarte requested to merge github/fork/vloncar/fancy_reports into main

Created by: vloncar

Description

As a cherry on top for a new release, I propose we make the printing of reports nicer for the user. Yes, this is a result of boredom because I didn't go skiing this weekend, but also because I don't like the ugly screenshots of text reports that many people place on their slides. I guess we can expand this in the future to be a bit more interactive and include the per-layer reports.

Note that the hidden among the style changes is a fix for parsing cosim reports. This previously failed on the accelerator backend.

To try it out, run something like

report = hls4ml.report.parse_vivado_report('/some/path/') # or report = hls_model.build(...)
hls4ml.report.print_vivado_report(report)

Hint: Run it in jupyter and as a script to see the difference, I won't spoil the fun here 😉

Type of change

  • New feature (non-breaking change which adds functionality)

Tests

The notebook part is not really testable with the current setup, and the text-based reports can only be tested for sanity (if the function fails or not), so I didn't add any tests.

Checklist

  • I have read the guidelines for contributing.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have installed and run pre-commit on the files I edited or added.
  • I have added tests that prove my fix is effective or that my feature works.

Merge request reports