用途:为 PyTorch 项目中的函数与方法编写 docstring,遵循 torch/_tensor_docs.py 与 torch/nn/functional.py 的约定。
主要能力:规定文档字符串结构,包括首行函数签名、简要描述、数学公式、交叉引用、Notes/Warnings、Args、Keyword args、Returns、Examples 与外部引用;并给出原生 Python 函数、C 绑定函数(_add_docstr)、原地变体(add_docstr_all)与别名函数的写法。
必要用法:统一使用原始字符串 r"""...""";采用 Sphinx/reStructuredText 格式;首行写函数签名且不以句号结尾;参数用 Args 段并标注类型与默认值;可选参数写 Default: 值;用双反引号包裹行内代码;用 :class:、:func:、:meth:、:attr:、:math: 等角色做交叉引用;张量形状用 LaTeX 数学记号;示例用 Examples:: 与 >>> 提示符;可复用 common_args 与模板插入。
适用场景:PyTorch 代码库中新增或更新函数、方法文档时。
限制:资料未提供该技能的安装命令、收费、平台或效果信息。