Does it support C++ bound functions?

Yes, the skill includes specific implementation patterns for documenting C-bound functions using the _add_docstr pattern common in PyTorch.

Does it generate usage examples automatically?

It provides the structure and guidelines to ensure every docstring includes at least one valid Python example following the 'Examples::' directive.

Does this skill handle LaTeX math?

Yes, it specifically instructs the use of raw strings and Sphinx math directives for tensor shapes and mathematical formulas to ensure correct rendering.

Is this skill only for the PyTorch core library?

While it follows PyTorch's internal conventions, it is ideal for any deep learning library that wants to maintain high-quality, Sphinx-compatible documentation.

PyTorch Docstring Writer

Name: PyTorch Docstring Writer
Author: arthur0824hao

byarthur0824hao

0•

学习与文档

Generates high-quality docstrings for PyTorch functions and methods following official Sphinx and reStructuredText conventions.

This skill automates the creation of standardized PyTorch documentation, ensuring that functions and methods adhere to the specific formatting rules used in torch/_tensor_docs.py and torch/nn/functional.py. It guides Claude in using raw strings for LaTeX math, structured argument blocks, cross-references via Sphinx roles, and comprehensive usage examples, making it indispensable for contributors to the PyTorch ecosystem or developers building PyTorch-compatible libraries that require professional-grade documentation.

主要功能

01Sphinx-compliant cross-referencing for classes, functions, and methods

020 GitHub stars

03Automated LaTeX math integration for tensor shapes and formulas

04Structured 'Args', 'Returns', and 'Examples' sections following reST

05Standardized PyTorch signature formatting with type annotations

06Support for C-bound functions (add_docstr) and in-place method variants

使用场景

01Documenting new modules or functions within the PyTorch core repository

02Standardizing documentation for custom PyTorch-based deep learning libraries

03Updating legacy PyTorch code to modern Sphinx documentation standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add arthur0824hao/skill docstring

For use in Claude.ai and ChatGPT

Download Skill