Diagram visualization of the albumentations codebase #2565
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.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all, I've generated (Static Analysis + LLMs) a diagram representation of the albumentations codebase.
You can check it here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/albumentations/on_boarding.md
These diagrams are designed to help people get up-to-speed with the codebase. I can see that the https://github.com/albumentations-team/albumentations repo has more than 1.7K forks, which means that a lot of people play around with the codebase and are not just users. We believe that visuals (diagrams) are the best entry to a new codebase, as they give high-level overview of the full codebase and then the dev can focus on the component of interest. When working within the component they now have the context of how that component fits in the big picture (also our diagram is explorable recursively so one can drill down deeper if needed).
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Beta Was this translation helpful? Give feedback.
All reactions