Add AST-based dataflow diagram generation for documentation#566
Open
archit7-beep wants to merge 18 commits intomllam:mainfrom
Open
Add AST-based dataflow diagram generation for documentation#566archit7-beep wants to merge 18 commits intomllam:mainfrom
archit7-beep wants to merge 18 commits intomllam:mainfrom
Conversation
Add auto-generated Mermaid diagrams for neural_lam codebase. dig_generator.py parses Python files and creates per-module flowcharts. dig_validator.py validates diagram nodes against actual code symbols.
Collaborator
|
Hi, could you add pictures of the diagrams here in the PR, so it is easier to get an idea of what they contain? |
Contributor
Author
@joeloskarsson I have updated the diagrams in description of PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
This PR introduces an initial prototype for generating dataflow diagrams from the codebase using an AST-based approach to improve documentation clarity.
The implementation extracts method-level relationships (e.g.,
process_step) and generates Mermaid-based diagrams representing how data flows through different components.This work complements the ongoing structured documentation efforts by adding visual context to better understand model and pipeline behavior.
##Example of Digrams
🔁 Data Flow
🏗️ Structure Diagram
Motivation:
While current documentation improves structure and API visibility, understanding data flow still requires manual code tracing. This approach aims to make data pipelines easier to understand and improve onboarding for new contributors.
Dependencies:
Issue Link
Related to ( #61 )
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee