-
Notifications
You must be signed in to change notification settings - Fork 209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revise README. #1747
Revise README. #1747
Conversation
README.md
Outdated
Here is an incorrect example that creates a memory resource on device zero and then uses it to | ||
allocate a `device_buffer` on device one: | ||
Here is an incorrect example that creates a memory resource on device 0 and then uses it to | ||
allocate a `device_buffer` on device 1: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please no
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Device indices are numbers, not words. CUDA_VISIBLE_DEVICES=zero
doesn't do the right thing, and you can't use a string when setting the current device. Can you provide a little more context for why words are your preference here? There are some grammar rules around spelling out numbers less than one hundred, but I don't think that is appropriate in this technical context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would take `0`
and `1`
I suppose.
The code immediately below uses the numbers (rather than spelled out), so I don't think this is likely to cause confusion by spelling them out in the prose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ll use monospace font, that is a good outcome.
$ cd rmm | ||
``` | ||
|
||
- Create the conda development environment `rmm_dev` | ||
```bash | ||
# create the conda environment (assuming in base `rmm` directory) | ||
$ conda env create --name rmm_dev --file conda/environments/all_cuda-118_arch-x86_64.yaml | ||
$ conda env create --name rmm_dev --file conda/environments/all_cuda-125_arch-x86_64.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is --name
even needed? It should be in the .yaml, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name in the environment is not as user-friendly. Overriding it is a better UX.
/merge |
Description
This PR applies some minor README revisions, like fixing outdated links.
Checklist