Visual Studio Code(簡稱 VS Code)是一個由微軟開發,同時支援 Windows、 Linux 和 macOS 等作業系統的免費程式碼編輯器,它支援測試,並內建了 Git 版本控制功能,同時也具有開發環境功能,例如程式碼補全、程式碼片段和程式碼重構等。VS Code 是程式設計師常用的程式碼編輯器之一,是一個可在所有平臺上使用的開源、可擴充套件和輕量級的編輯器。這些品質使微軟的 VS Code 大受歡迎,併成為 Python 開發的絕佳平臺。
此外,VS Code 還擁有大量擴充套件,可以幫助提高開發效率、提升開發幸福感。今天,我們要介紹的就是一款可以生成 Python 文件字串的 VS Code 擴充套件。
GitHub 地址:https://github。com/graykode/ai-docstring
擴充套件地址:https://marketplace。visualstudio。com/items?itemName=graykode。ai-docstring&ssr=false
該擴充套件利用 AI (NLP) 技術,快速生成 Python 函式的文件字串(docstring)。原本 Python 函式的描述必須由使用者編寫,而使用這款擴充套件之後,AI 可以檢視程式碼並進行總結。
具體而言,該擴充套件使用了微軟等提出的預訓練模型CodeBERT,該模型可以處理雙模態資料:自然語言和程式語言。
在訓練過程中,該擴充套件使用 GitHub 團隊建立的CodeSearchNet語料庫作為訓練資料,並使用 CodeBERT 中的 Code2NL(程式碼到自然語言)微調任務。該擴充套件的推斷基準如下所示:
特性
這款 VS Code 擴充套件具備以下特性:
AI 快速生成文件字串;
可以選擇多種不同型別的文件字串格式;
透過 pep484 型別提示、預設值和變數名,推斷引數型別;
支援 args、kwargs、decorators、errors 和 parameter 型別。
其中支援的文件字串格式包括:Google(預設)、docBlockr、Numpy、Sphinx,專案主頁顯示這款擴充套件還即將支援 PEP0257。
如何使用
這款 VS Code 擴充套件的使用較為簡單。使用者只需從容器中執行模型推斷伺服器,並在 VS Code 中安裝擴充套件,即可使用。
具體步驟如下所示:
1。 從容器中執行模型推斷伺服器
如果已有 GPU 機器:在安裝 nvidia-docker 後,執行 docker run -it -d ——gpus 0 -p 5000:5000 graykode/ai-docstring:gpu;
如果只有 CPU:利用 Google Colab 和 ngrok 執行 flask 伺服器(推薦)或者使用 docker cpu 映象:docker run -it -d -p 5000:5000 graykode/ai-docstring:cpu。
2。 在 VS Code 中安裝擴充套件並使用
游標必須在定義下方,以生成完全自動填充的文件字串。
使用三引號(“”“或‘’‘)開啟文件字串,然後按回車鍵;
鍵盤快捷鍵:ctrl+shift+2,Mac 電腦的快捷鍵是 cmd+shift+2;
命令:Generate Docstring;
右擊選單:Generate Docstring。
專案作者
該專案的作者是來自韓國慶熙大學的計算機工程本科生 Tae-Hwan Jung。他對開源文化感興趣,認為一個好的專案可以衍生新的行業和技術。
個人主頁:https://libraries。io/github/graykode
- DataCastle -