Python 文档字符串生成器:基于 CodeBERT,支持 Google、Numpy 等多种输出格式

又一款懒人神器问世了:

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 智能未来大会」启幕,

早鸟票限时抢购中,扫码预定席位!

李开复博士、尹浩院士、清华唐杰教授,以及来自小米、美团、爱奇艺、小冰、亚信、浪潮、容联、澎思、地平线、G7等知名 AI 大厂的大咖嘉宾齐聚,期待关注 AI 的朋友报名参会、共探新形势下智能产业发展之路。

量子位 QbitAI · 头条号签约作者

' ' 追踪 AI 技术和产品新动态

一键三连「分享」、「点赞」和「在看」

科技前沿进展日日相见 ~

热点文章
近期更新
友情链接

Powered by 澳门威斯尼斯人app下载 @2018 html地图

Copyright 站群 © 2013-2021 版权所有