Can it document C++ or Rust extensions for PyTorch?

Absolutely. The skill includes specific patterns for C-bound functions using _add_docstr, which is commonly used when bridging native code to Python.

Does it handle cross-linking to other PyTorch modules?

Yes, it uses Sphinx roles like :class:, :func:, and :meth: with the appropriate prefixes to create internal links within your documentation.

Does this skill support LaTeX mathematical formulas?

Yes, it follows PyTorch conventions by using raw strings and Sphinx math directives to ensure tensor shapes and mathematical logic are rendered correctly in documentation.

What documentation format does this skill use?

It primarily uses reStructuredText (reST) formatted for the Sphinx documentation generator, adhering to the specific style guides found in the core PyTorch repository.

PyTorch Docstring Writer

Name: PyTorch Docstring Writer
Author: teddytennant

byteddytennant

•

データサイエンスとML

Generates and updates professional PyTorch-style docstrings using Sphinx and reStructuredText conventions.

概要

The PyTorch Docstring Writer skill equips Claude with the specific domain knowledge required to document deep learning libraries according to the rigorous standards of the PyTorch project. It automates the creation of raw-string docstrings that include standardized function signatures, LaTeX mathematical formulas for tensor shapes, and Sphinx cross-references. This skill is essential for developers working on PyTorch forks, custom neural network modules, or high-performance C++/Rust extensions who need their documentation to be visually consistent and technically compatible with the official PyTorch ecosystem.

主な機能

Sphinx cross-referencing for classes, methods, and external research papers
1 GitHub stars
LaTeX math integration for complex formulas and tensor dimension shapes
Standardized PyTorch function signature formatting with type annotations
Support for C-bound function documentation and in-place operation variants
Structured Args and Keyword Args sections with precise indentation rules

ユースケース

Standardizing documentation across a large-scale deep learning codebase
Generating Python-side documentation for high-performance Rust or C++ tensor operations
Writing documentation for new neural network layers in a PyTorch-based framework

概要

主な機能

Sphinx cross-referencing for classes, methods, and external research papers
1 GitHub stars
LaTeX math integration for complex formulas and tensor dimension shapes
Standardized PyTorch function signature formatting with type annotations
Support for C-bound function documentation and in-place operation variants
Structured Args and Keyword Args sections with precise indentation rules

ユースケース

Standardizing documentation across a large-scale deep learning codebase
Generating Python-side documentation for high-performance Rust or C++ tensor operations
Writing documentation for new neural network layers in a PyTorch-based framework