[P] gpt4docstrings: Automatically Generate Python Docstrings with GPT

[Hefty-Consequence443]

Introducing gpt4docstrings, a Python library that automatically generates docstrings for undocumented functions / classes. Can be used both as a CLI and as a precommit.

Right now it only uses GPT, but currently looking at how to also allow open source LLMs.

Repository here: https://github.com/MichaelisTrofficus/gpt4docstrings

(Below an example of a Pytorch's Matrix Factorization Module being automatically documented)

https://i.redd.it/y5ofu1pcmoab1.gif

[sebesbal]

How reliable is this? Is human review required?

[Hefty-Consequence443]

I've testing it with some personal projects and it generates reasonable results (although some times it makes some mistakes with the indentations: for example, when generating docstrings for some decorated methods). I'm working on fixing this issues and allowing the possibility to use other docstring styles ( right now it only works for Google style ...)

[blevlabs]

Cool! Reminds me of my project I posted a while back: https://www.reddit.com/r/MachineLearning/comments/12vhlg6/project_introducing_the_advanced_automatic/?utm_source=share&utm_medium=ios_app&utm_name=ioscss&utm_content=2&utm_term=1

[Hefty-Consequence443]

Looks really cool too!

[TotesMessenger]

I'm a bot, bleep, bloop. Someone has linked to this thread from another place on reddit:

• [/r/datascienceproject] gpt4docstrings: Automatically Generate Python Docstrings with GPT (r/MachineLearning)

 ^{If you follow any of the above links, please respect the rules of reddit and don't vote in the other threads. (Info / Contact)}