用途:为 PyTorch 项目中的函数和方法编写 docstring,遵循 torch/_tensor_docs.py 与 torch/nn/functional.py 中的约定。
主要能力:规定 docstring 的整体结构,包括首行函数签名、简要描述、数学公式、交叉引用、注意事项与警告、Args、Keyword args、Returns、Examples 及外部引用等部分;并给出原生 Python 函数、C 绑定函数(add_docstr)、原地变体(如 abs)和别名函数(如 absolute)的写法。
必要用法:所有 docstring 使用原始字符串 r"""...""";采用 Sphinx/reStructuredText 格式;首行写函数签名(含位置参数、仅关键字参数、默认值与返回类型,且不以句号结尾);参数按 Args 段列出类型与说明,可选参数注明 Default;使用 :class:、:func:、:meth:、:attr:、:math: 等 Sphinx 角色;张量形状用 LaTeX 数学记号;示例用 Examples:: 与 >>> 提示符;可复用 common_args 与模板插入。
适用场景:在 PyTorch 代码库中新增或更新函数、方法文档时使用。
限制:资料未提供该技能的安装方式、运行命令、收费信息或平台支持情况,暂未提供。