Visualization for the pytorch-lightning codebase

[ivanmilevtues]

Hey all,

I am Ivan and I just finished my degree in ML/AI. Me and a friend have noticed that it can be quite hard to get to know new codebases without mentor, so we are building something to help this process.

We think that at the begining getting high-level understanding of the project is essential, further we think visuals are always the best way to get-to-know new codebase. That means to us diagrams, we generate such diagrams based on Static Analysis and LLMs. I generated one for the Pytorch-Lightning repository: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/lightning/on_boarding.md

I would love to hear what you think about the diagram and in general about such sort of documentation. I am also curious to get some insight on how people learn new codebases and if there is any process you already have in place, can we help it in some way?

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.