Skip to content
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

Merged
merged 2 commits into from
Dec 6, 2024
Merged

Revise README. #1747

merged 2 commits into from
Dec 6, 2024

Conversation

bdice
Copy link
Contributor

@bdice bdice commented Dec 5, 2024

Description

This PR applies some minor README revisions, like fixing outdated links.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@bdice bdice self-assigned this Dec 5, 2024
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Dec 5, 2024
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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please no

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link
Member

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?

Copy link
Contributor Author

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.

@bdice
Copy link
Contributor Author

bdice commented Dec 6, 2024

/merge

@rapids-bot rapids-bot bot merged commit 9b0e71d into rapidsai:branch-25.02 Dec 6, 2024
51 of 53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants