使用ChatGPT API创建Python文档，竟然如此简单

如何用 ChatGPT OpenAPI 生成 Python 文档字符串

微信搜索关注《Python学研大本营》，加入读者群，分享更多精彩

为Python代码编写文档是一项耗时且繁琐的任务，但它是开发可维护和可重用代码的重要部分。程序员中流传着一个笑话：程序员最烦两件事，第一是写文档，第二是别人不写文档！

随着最近ChatGPT的进步，现在可以使用这个由AI驱动的语言模型，用 OpenAPI为Python函数和模块自动生成文档。

OpenAPI每月免费提供多达5000个API请求，每天请求限制为1000个，它为非技术人员和开发人员等都提供了很好的选项。

前提条件：

• 注册获取Open API密钥

• 安装OpenAPI的Python软件包

pip install openai

具体步骤

• 第1步：定义你的Python函数

假设你有一个Python函数，用于计算两个数字的平均值，该函数名为avg，需要两个参数：

def avg(a, b):
    return (a + b)/2

• 第2步：导入OpenAPI包

import openai
import re

• 第3步：设置OpenAPI凭证

openai.api_key = "PLACE_YOUR_API_KEY_HERE"

• 第4步:为ChatGPT模型定义提示符

定义提示符，包括Python函数的名称和文档字符串。

然后我们使用openai.Completion.create()方法来生成文档，指定语言模型、提示和其他参数。

prompt = f"Generate Python documentation for the following function:\n\n{avg.__name__}{avg.__doc__}"
response = openai.Completion.create(
    engine="text-davinci-002",
    prompt=prompt,
    max_tokens=100,
    n=1,
    stop=None,
    temperature=0.5,
)

• 第5步：生成文档

最后，我们从API响应中提取生成的文档并将其打印到控制台。

documentation = response.choices[0].text
documentation = re.sub(r"\n", " ", documentation).strip()

print(documentation)

通过利用强大的AI功能来创建Python文档，我们可以节省大量的时间和精力。

推荐书单

《人工智能算法与实战Python+PyTorch）》

本书可视为一本以问题为导向的书籍, 非常适合具备一定数据基础和Python基础的读者学习,作为一本数据科学的基础书籍,读者可以在短时间内学习数据科学的经典算法。主要阐述 python3 基础内容；常用模块进行扼要阐述和实例操作；常见统计量, 数据转换, 以及多维数组等内容, 并通过代码实现；特色是以问题导向的方式阐述了常见的 12 种经典算法；并介绍了 pytorch 的相关内容, 并扼要阐述了深度学习中几种经典的神经网络算法, 以及 pytorch 实现经典的神经网络算法。

《人工智能算法与实战（Python+PyTorch）-微课视频版（大数据与人工智能技术丛书）》(于祥雨，李旭静，邵新平)【摘要 书评 试读】- 京东图书京东JD.COM图书频道为您提供《人工智能算法与实战（Python+PyTorch）-微课视频版（大数据与人工智能技术丛书）》在线选购，本书作者：，出版社：清华大学出版社。买图书，到京东。网购图书，享受最低优惠折扣!https://item.jd.com/12987864.html

精彩回顾

《GPT-4已来，Python API使用最新版GPT》

《震撼来袭，GPT-4全解读》

《超快速，使用ChatGPT编写回归和分类算法》

《事半功倍，使用ChatGPT编写Python函数》

《使用ChatGPT提升Python编程效率》

《如虎添翼，将ChatGPT和Python结合起来！》

微信搜索关注《Python学研大本营》，加入读者群

访问【IT今日热榜】，发现每日技术热点