I generated an interactive diagram for nerfacc

[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.

This is the highest level of abstraction for the nerfacc project:

graph LR
    Data_Input_Preprocessing["Data Input & Preprocessing"]
    Neural_Scene_Representation["Neural Scene Representation"]
    Spatial_Acceleration_Structures["Spatial Acceleration Structures"]
    Volumetric_Ray_Marching_Rendering["Volumetric Ray Marching & Rendering"]
    Core_Computational_Utilities["Core Computational Utilities"]
    Data_Input_Preprocessing -- "Provides Training/Inference Data" --> Neural_Scene_Representation
    Data_Input_Preprocessing -- "Supplies Ray Data" --> Volumetric_Ray_Marching_Rendering
    Neural_Scene_Representation -- "Outputs Scene Properties (RGB, Density)" --> Volumetric_Ray_Marching_Rendering
    Spatial_Acceleration_Structures -- "Optimizes Ray Sampling/Traversal" --> Volumetric_Ray_Marching_Rendering
    Volumetric_Ray_Marching_Rendering -- "Provides Density/Opacity Feedback" --> Spatial_Acceleration_Structures
    Core_Computational_Utilities -- "Provides Low-Level Computations" --> Data_Input_Preprocessing
    Core_Computational_Utilities -- "Provides Low-Level Computations" --> Neural_Scene_Representation
    Core_Computational_Utilities -- "Provides Low-Level Computations" --> Spatial_Acceleration_Structures
    Core_Computational_Utilities -- "Provides Low-Level Computations" --> Volumetric_Ray_Marching_Rendering
    click Data_Input_Preprocessing href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/Data_Input_Preprocessing.md" "Details"
    click Neural_Scene_Representation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/Neural_Scene_Representation.md" "Details"
    click Spatial_Acceleration_Structures href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/Spatial_Acceleration_Structures.md" "Details"
    click Volumetric_Ray_Marching_Rendering href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/Volumetric_Ray_Marching_Rendering.md" "Details"
    click Core_Computational_Utilities href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/Core_Computational_Utilities.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 here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nerfacc/on_boarding.md

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