I generated an interactive diagram representation of bindsnet

[ivanmilevtues]

Hey, all I've always wanted to contribute to open-source projects. I am a visual learner, so I love doing diagrams for myself as in the beggining I find it hard to wrap my head around the main flow and the main "logical" components.
To help people who like visual represnetations I started working on a project to automate this. The tool 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
    Data_Handling_Encoding["Data Handling & Encoding"]
    SNN_Core_Models_Topology_["SNN Core (Models & Topology)"]
    SNN_Simulation_Engine["SNN Simulation Engine"]
    Learning_Mechanisms["Learning Mechanisms"]
    Simulation_Environments["Simulation Environments"]
    Experiment_Orchestration["Experiment Orchestration"]
    ANN_to_SNN_Conversion["ANN-to-SNN Conversion"]
    Analysis_Visualization["Analysis & Visualization"]
    Data_Handling_Encoding -- "provides encoded data to" --> SNN_Simulation_Engine
    Data_Handling_Encoding -- "processes observations from" --> Simulation_Environments
    SNN_Core_Models_Topology_ -- "defines network structure for" --> SNN_Simulation_Engine
    SNN_Core_Models_Topology_ -- "is updated by" --> Learning_Mechanisms
    SNN_Core_Models_Topology_ -- "receives models from" --> ANN_to_SNN_Conversion
    SNN_Simulation_Engine -- "executes models from" --> SNN_Core_Models_Topology_
    SNN_Simulation_Engine -- "generates activity for" --> Learning_Mechanisms
    SNN_Simulation_Engine -- "produces data for" --> Analysis_Visualization
    Learning_Mechanisms -- "updates" --> SNN_Core_Models_Topology_
    Learning_Mechanisms -- "processes activity from" --> SNN_Simulation_Engine
    Simulation_Environments -- "provides observations to" --> Data_Handling_Encoding
    Simulation_Environments -- "is managed by" --> Experiment_Orchestration
    Experiment_Orchestration -- "orchestrates" --> Data_Handling_Encoding
    Experiment_Orchestration -- "orchestrates" --> SNN_Simulation_Engine
    Experiment_Orchestration -- "orchestrates" --> Learning_Mechanisms
    Experiment_Orchestration -- "orchestrates" --> Simulation_Environments
    Experiment_Orchestration -- "orchestrates" --> Analysis_Visualization
    ANN_to_SNN_Conversion -- "outputs converted models to" --> SNN_Core_Models_Topology_
    Analysis_Visualization -- "consumes data from" --> SNN_Simulation_Engine
    Analysis_Visualization -- "is triggered by" --> Experiment_Orchestration
    click Data_Handling_Encoding href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/Data_Handling_Encoding.md" "Details"
    click SNN_Core_Models_Topology_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/SNN_Core_Models_Topology_.md" "Details"
    click SNN_Simulation_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/SNN_Simulation_Engine.md" "Details"
    click Learning_Mechanisms href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/Learning_Mechanisms.md" "Details"
    click Simulation_Environments href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/Simulation_Environments.md" "Details"
    click Experiment_Orchestration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/Experiment_Orchestration.md" "Details"
    click ANN_to_SNN_Conversion href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/ANN_to_SNN_Conversion.md" "Details"
    click Analysis_Visualization href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bindsnet/Analysis_Visualization.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/bindsnet/on_boarding.md

Any feedback is appreciated! If you like it I would be more than happy to open a PR with all the diagrams and a free github action to keep them up-to-date.