[PyTorch] Documentation for op fuser API

[timmoon10]

Description

This PR adds a basic usage guide for the op fuser and includes it in the autogenerated API docs.

It is ready as-is, but if reviews take a while I may expand it with a guide on creating custom fused ops.

Type of change

• Documentation change (change only to the documentation, either a fix or a new content)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Infra/Build change
• Code refactoring

Changes

• Add basic usage guide for op fuser
• Include TE ops in autogenerated API docs
• Debug TE ops docstrings

Checklist:

• I have read and followed the contributing guidelines
• The functionality is complete
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[greptile-apps]

Greptile Summary

This PR adds comprehensive documentation for the operation fuser API, including a detailed usage guide with examples covering basic usage, quantization, and branching operations. The documentation also includes diagrams illustrating fusion patterns and implementation details.

The PR also improves docstring formatting across the ops module:

• Fixed RST formatting to use double backticks (``) for code references instead of single backticks
• Corrected parameter default formatting (e.g., True instead of True )
• Added missing spaces in hyperlink references
• Improved ClampedSwiGLU docstring formatting and structure

Key additions:

• New comprehensive guide at docs/examples/op_fuser/op_fuser.rst with motivation, usage examples, and implementation details
• Three diagram images showing fusion patterns for different operations
• Added ops module to API documentation with all operation classes
• Cleaned up docstrings across 18+ files for better Sphinx rendering

Minor issue found:

• Extra space before period in activation.py:387 (syntax issue)

Confidence Score: 5/5

• This PR is safe to merge with minimal risk - it only adds documentation and fixes docstring formatting
• This is a documentation-only PR that adds valuable user-facing documentation and improves code documentation. The changes are well-structured, comprehensive, and only one minor typo was found. All previous review comments about incorrect Linear arguments have been addressed.
• Only transformer_engine/pytorch/ops/basic/activation.py needs minor attention to fix the extra space before period on line 387

Important Files Changed

Filename	Overview
docs/examples/op_fuser/op_fuser.rst	New comprehensive documentation for op fuser API with usage examples and implementation details
docs/api/pytorch.rst	Added autogenerated API documentation for operation fuser classes and operations
transformer_engine/pytorch/ops/linear.py	Improved docstring formatting with proper RST syntax for code and parameter defaults
transformer_engine/pytorch/ops/sequential.py	Enhanced class docstring with improved formatting and punctuation
transformer_engine/pytorch/ops/basic/activation.py	Fixed spacing in hyperlinks and improved docstring formatting; minor typo with extra space before period

Sequence Diagram

sequenceDiagram
    participant User
    participant Documentation as docs/examples/op_fuser/op_fuser.rst
    participant API_Docs as docs/api/pytorch.rst
    participant Ops_Module as transformer_engine.pytorch.ops
    participant Docstrings as Python Docstrings

    User->>Documentation: Read op fuser guide
    Documentation->>Documentation: Learn basic usage
    Documentation->>Documentation: Learn quantization patterns
    Documentation->>Documentation: Learn branching operations
    
    User->>API_Docs: Reference API documentation
    API_Docs->>Ops_Module: Autogenerate from docstrings
    Ops_Module->>Docstrings: Source documentation
    
    Note over Documentation,Docstrings: PR improves formatting<br/>across all documentation layers
    
    Docstrings->>Docstrings: Fix RST syntax (double backticks)
    Docstrings->>Docstrings: Fix parameter defaults
    Docstrings->>Docstrings: Fix hyperlink spacing
    
    API_Docs->>User: Provide clean API reference
    Documentation->>User: Provide usage examples

Loading

[timmoon10]

/te-ci core pytorch

[greptile-apps]

Additional Comments (1)

1. transformer_engine/pytorch/ops/basic/activation.py, line 387 (link)

   syntax: Extra space before period.

   _{Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!}

_{19 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}