[PyTorch][Core][JAX] Expand troubleshooting docs

[jberchtold-nvidia]

Description

Expand the troubleshooting installation docs with a few recently debugged issues.

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

• Expand troubleshooting docs to add some recently debugged issues, including with uv venvs and JAX-specific issue symptoms.

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 expands the troubleshooting documentation in README.rst by adding three new sections covering recently debugged installation issues:

• UV/Virtual Environment Issues: Documents common problems when using uv or virtual environments, including import errors, cuDNN sublibrary loading failures, and wheel building issues
• JAX-specific Issues: Addresses FFI registration errors that occur when build isolation is not disabled during installation

The new content follows the existing documentation structure with symptom/solution pairs and provides actionable guidance for users experiencing these issues. The documentation additions are straightforward and helpful for users encountering these specific problems.

Confidence Score: 4/5

• This documentation-only PR is safe to merge with minimal risk
• The changes are purely additive to troubleshooting documentation with no code changes. Minor formatting inconsistencies (extra blank lines, hardcoded Python version) noted in previous review comments don't impact the utility or safety of merging
• No files require special attention

Important Files Changed

Filename	Overview
README.rst	Added troubleshooting sections for UV/venv issues and JAX FFI errors with minor formatting inconsistencies

Sequence Diagram

sequenceDiagram
    participant User
    participant README as README.rst
    participant Docs as Troubleshooting Docs
    
    User->>README: Encounters installation issue
    README->>Docs: Check Troubleshooting section
    
    alt UV/Virtual Environment Issue
        Docs->>User: Check "Problems using UV or Virtual Environments"
        User->>Docs: Review Import Error solution
        User->>Docs: Review cuDNN Loading Failed solution
        User->>Docs: Review Building Wheels solution
    else JAX-specific Issue
        Docs->>User: Check "JAX-specific Common Issues"
        User->>Docs: Review FFI Issues solution
        Note over User,Docs: Recommends --no-build-isolation flag
    else Other Build Issue
        Docs->>User: Check existing troubleshooting sections
        User->>Docs: Review compiler, headers, or build resource issues
    end
    
    User->>User: Apply solution with proper flags/environment variables
    User->>User: Successfully install TransformerEngine

Loading

[greptile-apps]

_{1 file reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

_{1 file reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

style: hardcoded Python version may not work for all users - consider using a generic placeholder like pythonX.Y or explaining users should adjust this

_{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!}

[greptile-apps]

style: extra blank line - RST should have only one blank line before code blocks (see lines 305-306 for consistent formatting)

_{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!}

[jberchtold-nvidia]

/te-ci