Adding a diagram representation to explore PaddleSlim's codebase #1918
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_Model_Input_Layer["Data & Model Input Layer"] Model_Optimization_Algorithms["Model Optimization Algorithms"] Automated_Compression_Orchestrator["Automated Compression Orchestrator"] Analysis_Evaluation_Tools["Analysis & Evaluation Tools"] Deployment_Inference_Layer["Deployment & Inference Layer"] Core_Framework_Utilities["Core Framework & Utilities"] Data_Model_Input_Layer -- "provides raw data and base models to" --> Model_Optimization_Algorithms Data_Model_Input_Layer -- "provides raw data and base models to" --> Automated_Compression_Orchestrator Automated_Compression_Orchestrator -- "triggers and configures" --> Model_Optimization_Algorithms Model_Optimization_Algorithms -- "outputs optimized models to" --> Analysis_Evaluation_Tools Analysis_Evaluation_Tools -- "provides feedback on model performance to" --> Automated_Compression_Orchestrator Analysis_Evaluation_Tools -- "provides feedback on model performance to" --> Model_Optimization_Algorithms Model_Optimization_Algorithms -- "outputs final optimized models to" --> Deployment_Inference_Layer Automated_Compression_Orchestrator -- "outputs optimized models to" --> Deployment_Inference_Layer Core_Framework_Utilities -- "provides foundational services to" --> Data_Model_Input_Layer Core_Framework_Utilities -- "provides foundational services to" --> Model_Optimization_Algorithms Core_Framework_Utilities -- "provides foundational services to" --> Automated_Compression_Orchestrator Core_Framework_Utilities -- "provides foundational services to" --> Analysis_Evaluation_Tools Core_Framework_Utilities -- "provides foundational services to" --> Deployment_Inference_Layer click Data_Model_Input_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Data_Model_Input_Layer.md" "Details" click Model_Optimization_Algorithms href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Model_Optimization_Algorithms.md" "Details" click Automated_Compression_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Automated_Compression_Orchestrator.md" "Details" click Analysis_Evaluation_Tools href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Analysis_Evaluation_Tools.md" "Details" click Deployment_Inference_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Deployment_Inference_Layer.md" "Details" click Core_Framework_Utilities href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PaddleSlim/Core_Framework_Utilities.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/PaddleSlim/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