docs: document PYTORCH_ROOT

[njzjz]

Summary by CodeRabbit

• Documentation
  • Introduced a new environment variable PYTORCH_ROOT for specifying the path to the PyTorch Python library. This variable is detected automatically to support building against the latest PyTorch version from PyPI.

[coderabbitai]

Walkthrough

Walkthrough

The recent update introduces a new environment variable, PYTORCH_ROOT, designed to specify the path to the PyTorch Python library. This variable is akin to TENSORFLOW_ROOT and is automatically detected. If the specified library path is invalid, the system will fall back to using the latest PyTorch version from PyPI or the version specified by PYTORCH_VERSION.

Changes

Files	Change Summary
doc/install/install-from-source.md	Added documentation for the new PYTORCH_ROOT environment variable, detailing its purpose, automatic detection, and fallback mechanism to PyPI for the latest PyTorch version.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Build System
    participant PyPI
    participant PyTorch Default Path

    User->>Build System: Set PYTORCH_ROOT
    Build System-->>PyTorch Default Path: Check if PyTorch library exists
    alt Library Exists
        PyTorch Default Path-->>Build System: Confirm existence
        Build System-->>User: Use specified PyTorch library
    else Library Does Not Exist
        Build System->>PyPI: Fetch latest version of PyTorch
        PyPI-->>Build System: Provide latest PyTorch library
        Build System-->>User: Use latest PyTorch library from PyPI
    end

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.83%. Comparing base (399646e) to head (4f2bc60).
Report is 105 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #3981      +/-   ##
==========================================
- Coverage   82.83%   82.83%   -0.01%     
==========================================
  Files         522      522              
  Lines       50872    50872              
  Branches     3015     3015              
==========================================
- Hits        42142    42138       -4     
- Misses       7795     7797       +2     
- Partials      935      937       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.