Who is this skill for?

It is designed for PyTorch core contributors, library developers, and data scientists who want their documentation to follow the professional standards of the PyTorch framework.

What is the PyTorch Docstring skill?

It is a specialized Claude Code skill that provides templates and rules for writing documentation that matches the PyTorch framework's internal standards, including specific formatting for tensor shapes and mathematical operations.

Does it support LaTeX and math formulas?

Yes, it specifically uses raw strings and Sphinx math directives to ensure that complex mathematical formulas used in machine learning render correctly in the final documentation.

Can it handle C-bound functions?

Yes, the skill includes specific patterns for documentation using add_docstr and add_docstr_all, which are used for documenting PyTorch functions implemented in C++.

Does it enforce code examples?

Yes, the skill encourages the inclusion of 'Examples::' blocks with properly formatted Python prompts (>>>) to ensure documentation is both informative and testable.

PyTorch Docstring Formatter

Name: PyTorch Docstring Formatter
Author: Activer007

byActiver007

学习与文档

Standardizes PyTorch documentation by generating Sphinx-compatible docstrings with mathematical formulas and precise argument definitions.

关于

This skill provides comprehensive guidance for writing and updating docstrings within the PyTorch ecosystem, ensuring compliance with internal standards found in torch/_tensor_docs.py and torch/nn/functional.py. It automates the complex formatting required for professional deep learning documentation, including the use of raw strings for LaTeX support, Sphinx/reStructuredText syntax, and cross-referencing to other PyTorch modules. It is an essential tool for framework maintainers and developers contributing to PyTorch-based libraries who need to maintain rigorous, publishable documentation standards.

主要功能

Standardized Args and Keyword Args section generation with type annotations
0 GitHub stars
Automated Sphinx/reStructuredText (reST) formatting
Example block generation with Python prompt and output formatting
Support for mathematical formulas using LaTeX directives
Intelligent cross-referencing for PyTorch classes, methods, and attributes

使用场景

Standardizing custom deep learning library documentation to match the PyTorch ecosystem style
Updating legacy docstrings to meet current PyTorch internal standards
Writing new documentation for PyTorch framework contributions

关于

主要功能

Standardized Args and Keyword Args section generation with type annotations
0 GitHub stars
Automated Sphinx/reStructuredText (reST) formatting
Example block generation with Python prompt and output formatting
Support for mathematical formulas using LaTeX directives
Intelligent cross-referencing for PyTorch classes, methods, and attributes

使用场景

Standardizing custom deep learning library documentation to match the PyTorch ecosystem style
Updating legacy docstrings to meet current PyTorch internal standards
Writing new documentation for PyTorch framework contributions