工程开发
docstring avatar

docstring

根据 PyTorch 惯例与 Sphinx 格式,自动生成或更新函数与方法的 docstring 文件说明。

简介

此技能旨在协助开发人员维护 PyTorch 仓库中高质量且标准化的说明文件。它能自动处理 Python 函数、方法及 C-bound API 的 docstring 编写与更新流程,确保严格遵循 torch._tensor_docs.py 与 torch.nn.functional 等模块中的专案惯例。此技能适用于为 PyTorch 贡献代码的软件工程师与研究人员,协助他们在维护跨套件一致性的同时,正确记录复杂的数学运算、张量处理或 API 变更。

本技能提供实作 reStructuredText (reST) 格式的结构化指导,这对于正确渲染 Sphinx 文件至关重要。它能协助使用者建构函数签名、撰写简短描述、使用 LaTeX 数学指令插入复杂公式,并透过正确的 Sphinx 角色来链接相关类、方法或属性。透过使用此工具,贡献者可以确保其文件不仅易读,且在技术上精确,并能透过 PyTorch 官方文件系统有效被搜寻与查阅。

  • 标准化函数签名格式,包含返回类型与关键字参数分隔符 (*)。

  • 确保使用原始字符串 (raw strings, r""),以避免 LaTeX 数学表达式中的反斜线跳脱问题。

  • 提供 Args、Keyword Args 及 Returns 区块的模板,确保缩排与类型注释风格统一。

  • 自动纳入包含标准 >>> 提示符的示例区块,以提升代码可读性与测试便利性。

  • 处理使用 _add_docstr 辅助函数之 C-bound 函数的技术需求。

  • 修改函数或方法时务必包含完整的 Examples 区块,以展示预期的使用方式。

  • 使用正确的交叉参照 (例如 :class:~torch.nn.Module) 以链接文件组件并优化导航。

  • 严格遵守说明与警告的注释风格,以标示如 NLLLoss 行为等关键的数值稳定性信息。

  • 确保数学表达式使用 .. math:: 指令,以利于 HTML 或 PDF 的正确渲染。

  • 此技能的输入应为函数或方法的实作内容;输出则是符合所有 PyTorch 仓库风格指南、可直接插入的 docstring。

仓库统计

Star 数
99,523
Fork 数
27,618
Open Issue 数
18,537
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 12:54
在 GitHub 查看