Explain install AMD #331
Explain install AMD #331
Conversation
WalkthroughThe installation instructions in Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File ( |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (7)
docs/installation.md (7)
Line range hint
3-3: Consider adding a comma after "For optimal performance".- For optimal performance the [flux framework](https://flux-framework.org) is recommended as job scheduler. + For optimal performance, the [flux framework](https://flux-framework.org) is recommended as job scheduler.
Line range hint
34-34: Consider adding a comma after "without a GPU".- When installing on a login node without a GPU the conda install command might fail with an Nvidia cuda related error, + When installing on a login node without a GPU, the conda install command might fail with an Nvidia cuda related error,
Line range hint
51-51: Change "in compatibility with" to "for compatibility with".- Flux is not limited to mpich / cray mpi, it can also be installed in compatibility with openmpi or intel mpi using the openmpi package: + Flux is not limited to mpich / cray mpi, it can also be installed for compatibility with openmpi or intel mpi using the openmpi package:
Line range hint
63-63: Consider adding a comma after "In this interactive shell".- In this interactive shell you can now list the available resources using: + In this interactive shell, you can now list the available resources using:
Line range hint
75-75: Consider adding a comma after "enabled by hyper-threading".- As flux only lists physical cores rather than virtual cores enabled by hyper-threading the total number of CPU cores might be half the number of cores you expect. + As flux only lists physical cores rather than virtual cores enabled by hyper-threading, the total number of CPU cores might be half the number of cores you expect.
Line range hint
99-99: Consider using a hyphen in "high-performance computing".- While this is not recommended in the high performance computing (HPC) context as `pympipool` with `block_allocation=False` is going to create a SLURM job step for each submitted python function. + While this is not recommended in the high-performance computing (HPC) context as `pympipool` with `block_allocation=False` is going to create a SLURM job step for each submitted python function.
Line range hint
107-107: Correct the capitalization of "macOS".- This also includes workstation installations on Windows and MacOS. + This also includes workstation installations on Windows and macOS.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/installation.md (1 hunks)
Additional Context Used
LanguageTool (9)
docs/installation.md (9)
Near line 3: Possible missing comma found.
Context: ...# Compatible Job Schedulers For optimal performance the [flux framework](https://flux-frame...
Near line 34: Possible missing comma found.
Context: ...en installing on a login node without a GPU the conda install command might fail wi...
Near line 51: The preposition ‘for’ seems more likely in this position.
Context: ...ch / cray mpi, it can also be installed in compatibility with openmpi or intel mpi...
Near line 63: It appears that a comma is missing.
Context: ...the flux scheduler. In this interactive shell you can now list the available resourc...
Near line 75: Possible missing comma found.
Context: ...her than virtual cores enabled by hyper-threading the total number of CPU cores might be...
Near line 99: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...). While this is not recommended in the high performance computing (HPC) context aspympipool...
Near line 99: Possible missing comma found.
Context: ...in the high performance computing (HPC) context aspympipoolwith `block_allocation=F...
Near line 101: Consider inserting a comma after an introductory phrase for better readability.
Context: ...p for each submitted python function. In this casepympipoolcan be installed using: ```...
Near line 107: The operating system from Apple is written “macOS”.
Context: ...orkstation installations on Windows and MacOS.
Markdownlint (79)
docs/installation.md (79)
3: Expected: 0 or 2; Actual: 1
Trailing spaces
4: Expected: 0 or 2; Actual: 1
Trailing spaces
7: Expected: 0 or 2; Actual: 1
Trailing spaces
9: Expected: 0 or 2; Actual: 1
Trailing spaces
10: Expected: 0 or 2; Actual: 1
Trailing spaces
15: Expected: 0 or 2; Actual: 1
Trailing spaces
16: Expected: 0 or 2; Actual: 1
Trailing spaces
17: Expected: 0 or 2; Actual: 1
Trailing spaces
18: Expected: 0 or 2; Actual: 1
Trailing spaces
21: Expected: 0 or 2; Actual: 1
Trailing spaces
23: Expected: 0 or 2; Actual: 1
Trailing spaces
27: Expected: 0 or 2; Actual: 1
Trailing spaces
28: Expected: 0 or 2; Actual: 1
Trailing spaces
29: Expected: 0 or 2; Actual: 1
Trailing spaces
30: Expected: 0 or 2; Actual: 1
Trailing spaces
39: Expected: 0 or 2; Actual: 1
Trailing spaces
40: Expected: 0 or 2; Actual: 1
Trailing spaces
42: Expected: 0 or 2; Actual: 1
Trailing spaces
43: Expected: 0 or 2; Actual: 1
Trailing spaces
44: Expected: 0 or 2; Actual: 1
Trailing spaces
45: Expected: 0 or 2; Actual: 1
Trailing spaces
51: Expected: 0 or 2; Actual: 1
Trailing spaces
52: Expected: 0 or 2; Actual: 1
Trailing spaces
58: Expected: 0 or 2; Actual: 1
Trailing spaces
63: Expected: 0 or 2; Actual: 1
Trailing spaces
64: Expected: 0 or 2; Actual: 1
Trailing spaces
75: Expected: 0 or 2; Actual: 1
Trailing spaces
76: Expected: 0 or 2; Actual: 1
Trailing spaces
79: Expected: 0 or 2; Actual: 1
Trailing spaces
84: Expected: 0 or 2; Actual: 1
Trailing spaces
89: Expected: 0 or 2; Actual: 1
Trailing spaces
90: Expected: 0 or 2; Actual: 1
Trailing spaces
91: Expected: 0 or 2; Actual: 1
Trailing spaces
100: Expected: 0 or 2; Actual: 1
Trailing spaces
1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
2: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
2: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
13: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
20: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
27: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
27: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
42: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
50: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
57: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
78: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
89: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
96: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
24: null
Fenced code blocks should be surrounded by blank lines
26: null
Fenced code blocks should be surrounded by blank lines
31: null
Fenced code blocks should be surrounded by blank lines
33: null
Fenced code blocks should be surrounded by blank lines
36: null
Fenced code blocks should be surrounded by blank lines
38: null
Fenced code blocks should be surrounded by blank lines
46: null
Fenced code blocks should be surrounded by blank lines
53: null
Fenced code blocks should be surrounded by blank lines
60: null
Fenced code blocks should be surrounded by blank lines
62: null
Fenced code blocks should be surrounded by blank lines
65: null
Fenced code blocks should be surrounded by blank lines
67: null
Fenced code blocks should be surrounded by blank lines
69: null
Fenced code blocks should be surrounded by blank lines
74: null
Fenced code blocks should be surrounded by blank lines
81: null
Fenced code blocks should be surrounded by blank lines
83: null
Fenced code blocks should be surrounded by blank lines
85: null
Fenced code blocks should be surrounded by blank lines
92: null
Fenced code blocks should be surrounded by blank lines
103: null
Fenced code blocks should be surrounded by blank lines
9: null
Spaces inside code span elements
24: null
Fenced code blocks should have a language specified
31: null
Fenced code blocks should have a language specified
36: null
Fenced code blocks should have a language specified
46: null
Fenced code blocks should have a language specified
53: null
Fenced code blocks should have a language specified
60: null
Fenced code blocks should have a language specified
65: null
Fenced code blocks should have a language specified
69: null
Fenced code blocks should have a language specified
81: null
Fenced code blocks should have a language specified
85: null
Fenced code blocks should have a language specified
92: null
Fenced code blocks should have a language specified
103: null
Fenced code blocks should have a language specified
Additional comments not posted (1)
docs/installation.md (1)
25-25: Update the installation command to includelibhwlocwith ROCm support for AMD GPUs.This change correctly updates the installation command to support AMD GPUs by including the
libhwloc=*=rocm*package, which is necessary for optimal GPU resource management with the flux framework.
Summary by CodeRabbit
libhwlocfor AMD GPUs with ROCm support.