Set ROCM_ROOT to ROCM_PATH when it exist

[sigbjobo]

This small commit closes issue #4149 by checking if rocm_root is not set, and then inferring it from rocm_path, if it exists.

Summary by CodeRabbit

• New Features
  • Enhanced flexibility in retrieving the ROCM root directory by checking both ROCM_ROOT and ROCM_PATH environment variables.
  • Updated installation documentation to clarify the fallback mechanism for locating the ROCM toolkit, ensuring users have clear guidance on configuration options.

[coderabbitai]

Walkthrough

Walkthrough

The pull request updates the get_argument_from_env function in the backend/read_env.py file to enhance the retrieval of the ROCM root directory. It introduces a conditional check for the ROCM_ROOT environment variable, and if it is not set, it checks the ROCM_PATH variable as an alternative. The changes also include updates to the documentation to clarify the fallback mechanism for locating the ROCM toolkit.

Changes

File	Change Summary
backend/read_env.py	Modified get_argument_from_env to check for ROCM_ROOT and fallback to ROCM_PATH if unset.
doc/install/install-from-source.md	Updated documentation to clarify the fallback mechanism for locating the ROCM toolkit.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Env
    participant CMakeArgs

    User->>Env: Check ROCM_ROOT
    alt ROCM_ROOT is set
        Env->>CMakeArgs: Append ROCM_ROOT to cmake_args
    else ROCM_ROOT is not set
        Env->>Env: Check ROCM_PATH
        alt ROCM_PATH is set
            Env->>CMakeArgs: Append ROCM_PATH to cmake_args
        else ROCM_PATH is not set
            Env->>CMakeArgs: Do not append anything
        end
    end

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f98f6f and efbe410.

Files selected for processing (1)

• doc/install/install-from-source.md (1 hunks)

Additional comments not posted (1)

doc/install/install-from-source.md (1)

158-159: LGTM!

The changes introduce a helpful fallback mechanism for setting the ROCM_ROOT environment variable. This improves the usability of the software for users who may not have explicitly defined ROCM_ROOT.

The instructions are clear and easy to follow. Great job!

---

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>, please review it.
  -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[njzjz]

Could you update the documentation?

deepmd-kit/doc/install/install-from-source.md

Lines 154 to 159 in c084b20

	:::{envvar} ROCM_ROOT
	**Type**: Path; **Default**: Detected automatically
	The path to the ROCM toolkit directory.
	:::

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.37%. Comparing base (c084b20) to head (efbe410).
Report is 1 commits behind head on devel.

Additional details and impacted files

@@           Coverage Diff           @@
##            devel    #4150   +/-   ##
=======================================
  Coverage   83.37%   83.37%           
=======================================
  Files         532      532           
  Lines       52166    52166           
  Branches     3046     3046           
=======================================
  Hits        43493    43493           
  Misses       7726     7726           
  Partials      947      947           

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

[sigbjobo]

Could you update the documentation?

deepmd-kit/doc/install/install-from-source.md

Lines 154 to 159 in c084b20

	:::{envvar} ROCM_ROOT
	**Type**: Path; **Default**: Detected automatically
	The path to the ROCM toolkit directory.
	:::

Sure, I added to the documentation.