用途:为 PyTorch 项目中的函数和方法编写 docstring,遵循 torch/_tensor_docs.py 与 torch/nn/functional.py 中的约定。主要能力:给出 docstring 整体结构(签名行、简要描述、数学公式、交叉引用、Notes/Warnings、Args、Keyword args、Returns、Examples、外部引用),并说明各类函数的处理方式,包括普通 Python 函数、通过 _add_docstr 绑定的 C 函数、以 _ 结尾的原地变体以及别名函数。用法要点:docstring 使用原始字符串 r"""...""",采用 Sphinx/reStructuredText 格式;首行写函数签名且不以句号结尾;参数按名称小写、类型置于括号内、可选参数标注 Default;用双反引号表示内联代码,用 :class:、:func:、:meth:、:attr:、:math: 等角色做交叉引用;张量形状用 LaTeX 数学记号;示例以 Examples:: 加 >>> 提示符书写;可复用公共参数定义与模板插入。限制:资料未提供该技能的安装命令、调用方式、许可与收费信息,暂未提供;内容仅覆盖 docstring 写作规范,不涉及自动生成或校验工具。
docstring
写作与研究
更新于 10-16 01:38