mlx-vlm icon indicating copy to clipboard operation
mlx-vlm copied to clipboard

Auto generated documentation

Open gabewillen opened this issue 1 year ago • 5 comments

You don't have to merge this. Just an example of auto generated documentation using AI. Unlike pasting code into chat-gpt or using copilot. This tool builds full dependency graphs and sends all the relevant code to the model in the context. It then injects the documentation into the parsed AST leaving the existing code untouched.

gabewillen avatar May 31 '24 09:05 gabewillen

The entire process took two minutes

gabewillen avatar May 31 '24 09:05 gabewillen

Want me to delete this PR?

gabewillen avatar Jun 01 '24 15:06 gabewillen

No, please keep it.

It's pretty interesting and I have lots of questions! 🔥

At the moment, I'm out on a trip for the weekend and will get back to all your comments soon :)

If it's open-source we might merge it and have it as a default tool like gradio.

Blaizzy avatar Jun 01 '24 16:06 Blaizzy

You don't have to merge this. Just an example of auto generated documentation using AI. Unlike pasting code into chat-gpt or using copilot. This tool builds full dependency graphs and sends all the relevant code to the model in the context. It then injects the documentation into the parsed AST leaving the existing code untouched.

I'm back,

@gabewillen this is impressive!

Where can I learn more about it?

Blaizzy avatar Jun 03 '24 18:06 Blaizzy

Hey and thanks! I'm finishing it up now yours was only but a few I've ran it completely on. Soon it will actually create material ui mkdoc sites along with the documentation.

gabewillen avatar Jun 09 '24 05:06 gabewillen