Is it compliant with official PyTorch standards?

Yes, it follows the conventions established in core PyTorch files like torch/_tensor_docs.py and torch/nn/functional.py.

Can it link to other PyTorch modules?

Yes, the skill includes formatting rules for cross-referencing classes, functions, and methods using Sphinx roles like :class:, :func:, and :meth:.

Does this skill support LaTeX math?

Yes, it specifically uses raw strings and Sphinx math directives to ensure complex deep learning formulas are rendered correctly without backslash escape issues.

Does it generate usage examples?

Absolutely. One of the core requirements of this skill is to include an 'Examples::' section with properly formatted Python prompts and outputs.

PyTorch Docstring Generator

Name: PyTorch Docstring Generator
Author: biobenkj

bybiobenkj

学习与文档

Writes and updates professional-grade docstrings for PyTorch functions and methods following official Sphinx and reStructuredText conventions.

关于

This skill provides Claude with specific expertise in drafting high-quality documentation for PyTorch-based projects. It enforces the strict formatting standards found in official PyTorch source code, including the use of raw strings for LaTeX math compatibility, standardized function signatures, and structured sections for arguments, return types, and usage examples. It is particularly useful for deep learning researchers and engineers who need to maintain clear, documentation-site-ready code that includes complex mathematical formulas and cross-references to other PyTorch modules.

主要功能

0 GitHub stars
Enforces Sphinx and reStructuredText (reST) formatting standards
Standardizes Args, Keyword Args, and Returns sections with type annotations
Ensures docstrings include functional code examples with proper prompt formatting
Handles complex LaTeX mathematical formulas using math directives
Automates cross-referencing to PyTorch classes, functions, and methods

使用场景

Adding mathematical definitions and tensor shape documentation to deep learning code
Standardizing documentation across a large-scale PyTorch research library
Documenting custom neural network layers and functional operations

关于

主要功能

0 GitHub stars
Enforces Sphinx and reStructuredText (reST) formatting standards
Standardizes Args, Keyword Args, and Returns sections with type annotations
Ensures docstrings include functional code examples with proper prompt formatting
Handles complex LaTeX mathematical formulas using math directives
Automates cross-referencing to PyTorch classes, functions, and methods

使用场景

Adding mathematical definitions and tensor shape documentation to deep learning code
Standardizing documentation across a large-scale PyTorch research library
Documenting custom neural network layers and functional operations