Visualization for the python codebase of the jupyter/notebook project #7661
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 Ivan recently gratuaded CS Student in ML/AI. This said I've used Jupyter notebooks a lot, however I've never looked into the codebase of the actual project. Me and a friend recognized that it can be quite intimidating to get started on new projects. I was wondering how do you go about this problem (on-boarding) people in jupyter? The two of us came to the conclusion that up-to-date visuals can be super useful especially in the begining. For code we belive that is diagrams, that is why we are generating automatically diagrams first documentation. We are stepping on top of static analysis and use LLMs.
I generated one for the notebook project, keep in mind we support just python, the jupyter code is ingored for now. You can see how the diagrams look here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/notebook/on_boarding.md
Any sort of feedback and opinions are more than welcome!
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