Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LLM-Generated Documentation Experiment for stm32plus (Gemini Pro, 1.2M Tokens) #236

Open
plops opened this issue Jul 7, 2024 · 0 comments

Comments

@plops
Copy link

plops commented Jul 7, 2024

Hi Andy,
I've been experimenting with using Google's Gemini Pro model to generate documentation for stm32plus, focusing on areas I'm particularly interested in. I fed it a curated 3.9MB selection of source files as context (1.2M tokens).
The result is a structured outline, with sections covering core library components, peripherals, and examples. I even started adding UML diagrams, but unfortunately, my browser crashed after the first one. While each request takes several minutes, it's still significantly faster than writing everything manually.

You can find the generated documentation in my fork: https://github.com/plops/stm32plus/tree/feature/llm_documentation/doc

Based on previous experiments, I believe this documentation could be quite helpful, especially since LLMs tend to avoid excessive "hallucination" when summarizing code.

Feel free to take a look when you have a moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant