利用CodeBERT,这个VS Code扩展可以自动生成Python文档字符串
点击上方“AI遇见机器学习”,选择“星标”公众号
重磅干货,第一时间送达
来自:机器之心
该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 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
欢迎关注我们,看通俗干货!
利用CodeBERT,这个VS Code扩展可以自动生成Python文档字符串相关推荐
- vscode python 自动补全_利用CodeBERT,这个VS Code扩展可以自动生成Python文档字符串...
机器之心报道 编辑:魔王 该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
- 这个VS Code扩展可以自动生成Python文档字符串
机器之心报道 编辑:魔王 该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
- Sphinx——自动生成Python文档
Sphinx是一个可自动生成python项目api的工具,使用起来也比较简单,只需要在项目上进行简单的配置,即可生成项目的api文档 简介 Sphinx是Python文档生成器,它基于reStruct ...
- Python文档字符串生成器:基于CodeBERT,支持Google、Numpy等多种输出格式
木易 发自 凹非寺 量子位 报道 | 公众号 QbitAI 又一款懒人神器问世了: Visual Studio Code的扩展,基于CodeBERT的Python文档字符串生成器. 看来现在,这群偷 ...
- 自动生成接口文档之JApiDocs教程
JApiDocs教程 前言 作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
- swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档 使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器 二.下载 swagger-php ...
- PHP使用swagger-php自动生成api文档(详细附上完整例子)
thinkphp5结合swagger自动生成接口文档 整体介绍 swagger-php.swagger-ui.swagger-editor swagger-ui:主要就是放到tp项目public目录下 ...
- python新建word文档_使用Python 自动生成 Word 文档的教程
当然要用第三方库啦 :) 使用以下命令安装: pip install python-docx 使用该库的基本步骤为: 1.建立一个文档对象(可自动使用默认模板建立,也可以使用已有文件). 2.设置文档 ...
- python自动生成和读取word_使用Python自动生成Word文档的教程
当然要用第三方库啦 :) 使用以下命令安装: pip install python-docx 使用该库的基本步骤为: 1.建立一个文档对象(可自动使用默认模板建立,也可以使用已有文件). 2.设置文档 ...
最新文章
- mxnet可视化模型中间层feature map输出
- 使用C语言和i2c-dev驱动
- 【WPF】屏幕右下角消息提示框
- php 与时间有关的函数,php中与时间相关的常用函数有哪些
- 位运算判断奇偶数_位运算符判断奇偶
- @Transactional 注解的失效场景
- 【洛谷 P2303】 [SDOi2012]Longge的问题 (欧拉函数)
- 持续集成之配置TeamCity
- SQLServer 优化SQL语句 in 和not in的替代方案
- Codeforces Round #719 (A-C)
- 汉字转UNICODE?
- [导入]QZONE跳转FLASH地址生成工具
- Zephyr Team Hiring
- 再写轮播图——两张图切换,一张充当背景并且模糊,一张做展示图
- matlab仿真函数,matlab自动控制仿真常见函数应用
- Word复制表格样式变化问题
- 如何搭建一个自己的微信公众号
- 华为手机怎么测试Android,华为手机怎么对硬件进行检测?华为手机硬件检测教程...
- 动态规划:钢条切割问题
- 请写出一段 python 代码实现删除一个 list 里面的重复元素