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

Fix ordering / heading levels in README.md and python example in guide.md #1513

Merged

Conversation

harrism
Copy link
Member

@harrism harrism commented Apr 2, 2024

Description

This is a minor fix to reorder some of the C++ docs in README.md and fix heading levels. It also adds prompt characters to the pytorch allocator example in the Python guide.md to be consistent with other examples in the doc.

Checklist

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

@harrism harrism requested a review from a team as a code owner April 2, 2024 04:02
@harrism harrism added doc Documentation Python Related to RMM Python API non-breaking Non-breaking change labels Apr 2, 2024
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Minor quibbles, looks good!

python/docs/guide.md Outdated Show resolved Hide resolved
```python
from rmm.allocators.torch import rmm_torch_allocator
import torch
```python
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Why the indentation of this whole block by a single character? I think it is unnecessary.

Copy link
Member Author

Choose a reason for hiding this comment

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

Did I do thaaaat? :)

README.md Outdated Show resolved Hide resolved
@harrism harrism requested a review from wence- April 9, 2024 20:34
@wence-
Copy link
Contributor

wence- commented Apr 10, 2024

/merge

@rapids-bot rapids-bot bot merged commit 6771b71 into rapidsai:branch-24.06 Apr 10, 2024
52 checks passed
@wence-
Copy link
Contributor

wence- commented Apr 10, 2024

I noticed while reading through that we still say that one must manually ensure that the correct device is active when the destructor for a device_buffer runs. However, since #1370 this is no longer required (though it is still required for rmm::device_vector). I will open a separate change.

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 Python Related to RMM Python API
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants