Adding an interactive diagram representaiton of tods' codebase for exploration #122
Closed
ivanmilevtues
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
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_Ingestion_Validation["Data Ingestion & Validation"] Data_Preprocessing["Data Preprocessing"] Time_Series_Transformation["Time Series Transformation"] Feature_Engineering["Feature Engineering"] Anomaly_Detection_Algorithms["Anomaly Detection Algorithms"] Post_processing_Calibration["Post-processing & Calibration"] Pipeline_Orchestration["Pipeline Orchestration"] AutoML_Engine["AutoML Engine"] Data_Ingestion_Validation -- "provides raw data to" --> Data_Preprocessing Data_Preprocessing -- "provides clean, structured data to" --> Time_Series_Transformation Data_Preprocessing -- "provides clean, structured data to" --> Feature_Engineering Time_Series_Transformation -- "enhances data for" --> Feature_Engineering Feature_Engineering -- "supplies processed features to" --> Anomaly_Detection_Algorithms Anomaly_Detection_Algorithms -- "outputs raw detections to" --> Post_processing_Calibration Pipeline_Orchestration -- "orchestrates" --> Data_Preprocessing Pipeline_Orchestration -- "orchestrates" --> Time_Series_Transformation Pipeline_Orchestration -- "orchestrates" --> Feature_Engineering Pipeline_Orchestration -- "orchestrates" --> Anomaly_Detection_Algorithms Pipeline_Orchestration -- "orchestrates" --> Post_processing_Calibration AutoML_Engine -- "optimizes" --> Pipeline_Orchestration click Data_Preprocessing href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Data_Preprocessing.md" "Details" click Time_Series_Transformation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Time_Series_Transformation.md" "Details" click Feature_Engineering href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Feature_Engineering.md" "Details" click Anomaly_Detection_Algorithms href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Anomaly_Detection_Algorithms.md" "Details" click Post_processing_Calibration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Post_processing_Calibration.md" "Details" click Pipeline_Orchestration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/Pipeline_Orchestration.md" "Details" click AutoML_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/tods/AutoML_Engine.md" "Details"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/tods/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.
Beta Was this translation helpful? Give feedback.
All reactions