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。