I generated an interactive diagram to explore hls4ml

[ivanmilevtues]

Hey, all I've always wanted to contribute to open-source projects. But at the very begining I found it a bit too difficult to navigate them and wrap my head around on the main flow and the main "logical" components. That is why I started working on a project to help people like me, who are visual learners. The project generates an interactive diagram starting from the highest level of abstraction and allows you to dive deeper into interesting components.

Here is the diagram:

graph LR
    Model_Frontend_Input_Adapters_["Model Frontend (Input Adapters)"]
    Intermediate_Representation_IR_Core["Intermediate Representation (IR) Core"]
    Optimization_Engine["Optimization Engine"]
    HLS_Backends["HLS Backends"]
    Code_Generation_Project_Writer["Code Generation & Project Writer"]
    Profiling_Reporting["Profiling & Reporting"]
    Model_Frontend_Input_Adapters_ -- "converts models into" --> Intermediate_Representation_IR_Core
    Intermediate_Representation_IR_Core -- "provides IR to" --> Optimization_Engine
    Optimization_Engine -- "returns optimized IR to" --> Intermediate_Representation_IR_Core
    Intermediate_Representation_IR_Core -- "supplies IR to" --> HLS_Backends
    HLS_Backends -- "directs generation of files by" --> Code_Generation_Project_Writer
    click Model_Frontend_Input_Adapters_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/Model_Frontend_Input_Adapters_.md" "Details"
    click Intermediate_Representation_IR_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/Intermediate_Representation_IR_Core.md" "Details"
    click Optimization_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/Optimization_Engine.md" "Details"
    click HLS_Backends href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/HLS_Backends.md" "Details"
    click Code_Generation_Project_Writer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/Code_Generation_Project_Writer.md" "Details"
    click Profiling_Reporting href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/Profiling_Reporting.md" "Details"

Loading

The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding

You can see the full diagram with explanations and related source code here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/hls4ml/on_boarding.md

Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!