docstring

Write PyTorch function docstrings using reST format with raw strings, examples, and cross-references.

• Use raw strings (r""") for docstrings
• Follow reST format with function signature, brief description, and structure
• Include examples and cross-references to related functions/classes
• Use math formulas with Sphinx math directives

• Start with function signature showing all parameters
• Use Sphinx math for mathematical expressions
• Include cross-references with ~ prefix for brevity
• Always include examples and return type
• Use admonitions for notes and warnings
• Follow strict formatting for args/returns

1. 1.Start docstring with function signature in raw string
2. 2.Add brief description and mathematical formulas if applicable
3. 3.Document all args with type, default, and description
4. 4.Include examples with >>> prompts and output
5. 5.Use cross-references to related classes/functions
6. 6.Use admonitions for notes and warnings