What documentation format does this skill follow?

This skill follows the Sphinx and reStructuredText (reST) conventions specifically used in the PyTorch project, such as those found in torch/nn/functional.py.

Why does the skill insist on using raw strings for docstrings?

Raw strings (r"""...""") are essential in PyTorch documentation to prevent Python from misinterpreting backslashes used in LaTeX math formulas as escape characters.

Can this skill help with C-bound functions or aliases?

Yes, it includes specific patterns for using the _add_docstr method and documenting in-place variants or function aliases according to PyTorch internals.

Does it support mathematical formulas in docstrings?

Yes, the skill provides templates and rules for using Sphinx math directives and inline LaTeX for complex equations and tensor shapes.

PyTorch Docstring Formatter

Name: PyTorch Docstring Formatter
Author: Microck

byMicrock

•

Aprendizaje y Documentación

Generates and updates PyTorch-compliant docstrings using Sphinx formatting and official framework conventions.

Acerca de

This skill provides specialized guidance for writing professional-grade documentation for PyTorch functions and methods. It ensures strict adherence to the PyTorch framework's conventions, including the use of raw strings for LaTeX compatibility, Sphinx/reStructuredText (reST) formatting, and standardized sections for arguments, return types, and mathematical formulas. Whether you are contributing to the PyTorch core or building compatible libraries, this skill automates the creation of complex signatures and cross-references required for high-quality machine learning documentation.

Características Principales

Automates the creation of standardized Args, Returns, and Examples sections.
Handles specialized patterns like C-bound functions, in-place variants, and aliases.
Standardizes documentation using Sphinx and reStructuredText (reST) formatting.
89 GitHub stars
Enforces the use of raw strings to prevent LaTeX and math backslash errors.
Supports mathematical equations and tensor shape documentation using LaTeX.

Casos de Uso

Updating legacy machine learning codebases to match official PyTorch documentation styles.
Generating cross-referenced documentation for third-party PyTorch-based libraries.
Writing standardized documentation for new PyTorch neural network modules and functions.

Acerca de

Características Principales

Automates the creation of standardized Args, Returns, and Examples sections.
Handles specialized patterns like C-bound functions, in-place variants, and aliases.
Standardizes documentation using Sphinx and reStructuredText (reST) formatting.
89 GitHub stars
Enforces the use of raw strings to prevent LaTeX and math backslash errors.
Supports mathematical equations and tensor shape documentation using LaTeX.

Casos de Uso

Updating legacy machine learning codebases to match official PyTorch documentation styles.
Generating cross-referenced documentation for third-party PyTorch-based libraries.
Writing standardized documentation for new PyTorch neural network modules and functions.