工程開發
docstring avatar

docstring

標準化 PyTorch 函數說明文件的撰寫,確保符合 Sphinx、reStructuredText 以及 PyTorch API 的文件編寫規範。

簡介

此技能協助開發人員撰寫、更新並標準化 PyTorch 函數、方法與類別的 docstring。它確保文件嚴格遵守專案定義的規範(如 torch/_tensor_docs.py 與 torch/nn/functional.py 中的約定)。透過強制執行統一格式,此技能有助於利用 Sphinx 產生一致的 API 參考文件,讓 PyTorch 程式碼庫對貢獻者與使用者而言更具可維護性、可讀性與專業度。無論是為深度學習算子、工具函數,還是使用 _add_docstr 的 C 綁定方法撰寫文件,該代理程式都會應用嚴格的風格與結構要求,以確保高品質的技術文件產出。

  • 自動強制使用原始字串 (r"""),以避免 LaTeX 與數學公式中常見的反斜線跳脫問題。

  • 支援標準 Sphinx 與 reStructuredText (reST) 指令,包括數學區塊、提示(註解/警告)以及交叉引用。

  • 驗證必要區塊,例如函數簽章、參數型別註解、回傳型別以及關鍵字參數。

  • 協助建立使用 >>> doctest 風格的範例,並確保結構化程式碼格式的正確性。

  • 處理 C 綁定函數的特殊文件需求,確保原生 Python 實作與 C 擴充功能在文件深度上保持一致。

  • 協助透過 Sphinx 角色整合外部參考資料與論文引用。

  • 使用者應輸入函數簽章或實作程式碼,以便接收符合規範的 docstring 架構。

  • 代理程式預期符合標準的 PyTorch 參數格式,例如識別選擇性參數、預設值,並使用 :math: 標記來描述張量形狀。

  • 請務必確認對其他類別或方法的交叉引用正確使用波浪號 (~) 前綴,以維持簡潔的文件路徑。

  • 確保所有數學運算式均正確包裹在 .. math:: 或行內 :math: 角色中,以便在 HTML/PDF 文件建置中正確呈現。

  • 使用指定的 Args、Keyword args 與 Returns 區塊命名慣例,以與現有的 PyTorch 函式庫模式保持一致。

倉庫統計

Star 數
99,511
Fork 數
27,617
Open Issue 數
18,532
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月29日 上午03:29
在 GitHub 查看