I created an interactive diagram representation of LightZero's codebase #404
Closed
ivanmilevtues
started this conversation in
Show and tell
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 am working on an open-source tool to generate interactive diagram representations of codebases. The diagram starts from the highest level of abstraction and if you click on any of the components, there is a diagram in the same style for that component:
graph LR Policy["Policy"] Model["Model"] MCTS["MCTS"] Data_Management_Buffer["Data Management/Buffer"] Training_Orchestrator["Training Orchestrator"] Worker["Worker"] Environment_Zoo_["Environment (Zoo)"] Reward_Model_Optional_["Reward Model (Optional)"] Training_Orchestrator -- "initiates training" --> Policy Policy -- "interacts with" --> Environment_Zoo_ Environment_Zoo_ -- "interacts with" --> Policy Policy -- "queries and updates" --> Model Policy -- "delegates action selection to" --> MCTS MCTS -- "returns actions/statistics to" --> Policy Policy -- "stores/retrieves data from" --> Data_Management_Buffer Data_Management_Buffer -- "stores/retrieves data from" --> Policy Worker -- "facilitates interaction with" --> Policy Reward_Model_Optional_ -- "provides intrinsic rewards to" --> Policy MCTS -- "queries" --> Model Worker -- "manages" --> Environment_Zoo_ click Policy href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/Policy.md" "Details" click Model href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/Model.md" "Details" click MCTS href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/MCTS.md" "Details" click Training_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/Training_Orchestrator.md" "Details" click Worker href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/Worker.md" "Details" click Environment_Zoo_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/LightZero/Environment_Zoo_.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 here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/CompressAI/on_boarding.md
Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!
Beta Was this translation helpful? Give feedback.
All reactions