syl21/llmdocstring repository overview

image based on the work of: https://github.com/mgzenitech/llmdocstring⁠ which is based on the work of: https://github.com/burakbudanur/llmdocstring⁠ which is in turn based on the work of: https://github.com/graykode/ai-docstring⁠

Main difference is that this version uses a quantized version of Mistral-AI's 7B model and attempts to produce a complete docstring including variable types and descriptions according to the chosen template.

USAGE: docker run -it -d -p 5000:5000 syl21/llmdocstring:0.1

image basée sur le travail de : https://github.com/mgzenitech/llmdocstring⁠ qui a basé son travail sur : https://github.com/burakbudanur/llmdocstring⁠ qui a lui-même basé son travail sur : https://github.com/graykode/ai-docstring⁠

La principale différence est que cette version utilise une version quantifiée du modèle 7B de Mistral-AI et tente de produire une docstring complète incluant les types et descriptions des variables selon le modèle choisi.

USAGE: docker run -it -d -p 5000:5000 syl21/llmdocstring:0.1

On vscode use “LLM-based Python docstring generator” : (https://marketplace.visualstudio.com/items?itemName=burakbudanur.llmdocstring⁠) === KNOW ERRORS === 1/

• When: starting container
• Where: Docker terminal
• What: OpenBLAS blas_thread_init: pthread_create failed for thread 1 of 8: Operation not permitted OpenBLAS blas_thread_init: RLIMIT_NPROC 1048576 current, 1048576 max
• Why: https://docs.docker.com/engine/security/seccomp/⁠
• Solution: Update your docker version
• Workaround: “docker run --security-opt seccomp=unconfined -d -p5000:5000 llmdocstring”

2/

• When: Creating a DocString
• Where: Docker terminal
• What: KeyError: 'snippet' 172.17.0.1 - - [25/Jul/2024 08:06:49] "POST /summary HTTP/1.1" 500 –
• Why: You are using vscode plugin “AI Python Docstring Generator” (https://marketplace.visualstudio.com/items⁠ itemName=graykode.ai-docstring)
• Solution: Replace vscode plugin “AI Python Docstring Generator” by “LLM-based Python docstring generator” (https://marketplace.visualstudio.com/items?itemName=burakbudanur.llmdocstring⁠)