Python文档字符串生成器:基于CodeBERT,支持Google、Numpy等多种输出格式
木易 发自 凹非寺
量子位 报道 | 公众号 QbitAI
又一款懒人神器问世了:
Visual Studio Code的扩展,基于CodeBERT的Python文档字符串生成器。
看来现在,这群偷「懒」的程序员们连文档字符串都不想自己写了。
基于CodeBERT的生成器
跟正常的DocStrings用法一样,你只需要输入三引号「“””」,之后按Enter,便能调用这个工具。就像这样:
并且,这个生成器还可以在几种不同类型的文档字符串格式之间进行选择。
而这个工具,不仅仅能够帮助写代码的人,还可以方便后来人读代码。可以说是非常方便的一个扩展了。
这个工具的本质,就是一个自然语言识别的AI,它能够识别你所写代码的内容,然后输出对应的字符串。
具体是如何识别的,该AI的作者是这么介绍的:
参数类型是通过PEP 484类型、默认值和var标签进行识别的。
识别输入之后便是推断,这之间进行训练的方法,也并不复杂,通过CodeBERT便可以实现。
CodeBERT是一种双模预训练模型,它可以捕捉自然语言和编程语言之间的语义连接,是目前已知的第一个大型 NL-PL(自然语言-编程语言)预训练模型。
在训练过程中,使用 CodeSearchNet 语料库作为训练数据,并使用 CodeBERT 中的 Code2NL微调任务。
之后,进行的推断基准测试如下:
从上图也能看出,在不同的推断基准测试中,所需要的生成时间都很短(2s内),这体现在操作上的话,就是延迟。
目前,这个生成器可以支持识别args、kwargs、decorators和errors等参数类型。
此外,还可以输出Google、docBlockr、Numpy、Sphinx等Docstring格式,PEP0257类型的格式,也即将上线。
使用方法
1、从容器中运行模型推断服务
具有GPU的话:在安装nvidia-docker后,运行docker run-it-d-GPU 0-p 5000:5000 gray kode/ai-docstring。
只有CPU:运行docker run-it-d-p 5000:5000 gray kode/ai-docstring。
2、在VSCode中安装扩展并使用
光标必须在定义正下方的行上,以生成完全自动填充的文档字符串。
用三重引号「“””或‘’’」打开文档字符串后,按Enter键;
键盘快捷键是ctrl+shift+2,Mac为cmd+shift+2。
网友讨论
该生成器一经发布,便引起了网友们的讨论。
有网友认为这是一项非常便利的技术,非常期待:
不过,也有网友认为这项技术仍具有不小的局限性:
比如这位网友认为:更常见的注释,是在代码中没有立即出现的上下文之间添加内容。
不过,虽然有局限,但是人总是在「懒」的过程中变得更「懒」(狗头)。
比如jQuery的流行,是因为开发者懒得为DOM编写跨浏览器兼容性代码;
而之后Angular.js的流行,是因为开发者连DOM都懒得操作。
所以,还是非常期待这个扩展的后续,这些程序员能不能针对这些局限性进一步偷懒的。
获取资源
目前这个扩展已经在Visual Studio Code上免费上线。
进入链接即可获取资源:
https://marketplace.visualstudio.com/items?itemName=graykode.ai-docstring
也可以通过Github获取源文件:
https://github.com/graykode/ai-docstring
— 完 —
本文系网易新闻•网易号特色内容激励计划签约账号【量子位】原创内容,未经账号授权,禁止随意转载。
「MEET 2021智能未来大会」启幕,
早鸟票限时抢购中,扫码预定席位!


量子位 QbitAI · 头条号签约作者
վ'ᴗ' ի 追踪AI技术和产品新动态
一键三连「分享」、「点赞」和「在看」
科技前沿进展日日相见~
关注公众号:拾黑(shiheibook)了解更多
[广告]赞助链接:
四季很好,只要有你,文娱排行榜:https://www.yaopaiming.com/
让资讯触达的更精准有趣:https://www.0xu.cn/

随时掌握互联网精彩
- 1 长江的美丽变奏 7945024
- 2 中央一号文件:推进农村高额彩礼治理 7964277
- 3 DeepSeek预测《哪吒2》最终票房 7807155
- 4 小包裹折射中国经济澎湃动能 7746630
- 5 不允许城镇居民到农村买农房、宅基地 7669041
- 6 国防部深感诧异强烈不满 7504406
- 7 马库斯被北京的空气质量震惊了 7456132
- 8 终于有部剧还原了我的高清童年 7338156
- 9 王曼昱4比0胜孙颖莎 首夺亚洲杯冠军 7263187
- 10 张家界导游被指埋怨游客不消费 7122901