fastmachinelearning / hls4ml

Machine learning on FPGAs using HLS

https://fastmachinelearning.org/hls4ml

Apache License 2.0

1.19k stars 390 forks source link

Minor documentation updates #774

Closed jmitrevs closed 1 year ago

jmitrevs commented 1 year ago

Description

I updated the status to more clearly indicate that QONNX isn't included but in development. I also tried to rename the "Software Details" section--I am still not sure what is the best name and/or location for this info, but this is what I came up with. I also made minor text changes in the optimizers and flows documentation.

Feel free to update the docs in this PR. I am hoping this is the last PR and then we can make 0.7.0.

Type of change

[x] Documentation update

Checklist

[x] I have read the guidelines for contributing.
[x] I have made corresponding changes to the documentation.
[x] My changes generate no new warnings.
[x] I have installed and run pre-commit on the files I edited or added.

jmitrevs commented 1 year ago

I am not sure about the best order/organization of the left tabs, but that’s not a showstopper. (e.g. Do we want to move Command line interface to go down in the Quick API Interface? Or is it better as is? Should Software Details and Optimizer Passes and flows go in Advanced Features or stay where they are? If you want to reorder, go ahead. I think this is the last PR for 0.7.0, so when you are satisfied, accept and merge this PR, and we can do the release. I am fine with any ordering.