利用CodeBERT，这个VS Code扩大可以自动天生Python文档字符串

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

Powered by Froala Editor