Skip to content

Expand documentation on Buffer and Memory Resource lifetimes #2038

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

Expand documentation on Buffer and Memory Resource lifetimes #2038

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e574dba
Added note about buffer and MR lifetimes
TomAugspurger Sep 18, 2025
f71da73
remove extra colons
TomAugspurger Sep 18, 2025
0028289
remove {ref}
TomAugspurger Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ example, enabling the `ManagedMemoryResource` tells RMM to use
>>> rmm.mr.set_current_device_resource(rmm.mr.ManagedMemoryResource())
```

> :warning: The default resource must be set for any device **before**
> ⚠️ The default resource must be set for any device **before**
> allocating any device memory on that device. Setting or changing the
> resource after device allocations have been made can lead to unexpected
> behaviour or crashes.
Expand Down Expand Up @@ -157,6 +157,16 @@ Similarly, to use a pool of managed memory:
>>> rmm.mr.set_current_device_resource(pool)
```

> ⚠️ Take care when deleting a memory resource object,
> either explicitly or when its reference count drops to zero.
> All buffers that were allocated on that memory resource should
> be freed *before* the memory resource itself is deleted.
>
> Note that a Python exception that's raised in a scope that allocates
> buffers can keep references to the buffers that will keep them alive.
> Use ``traceback.clear_frames`` to ensure those buffers are freed
> before destroying the memory resource.
Comment on lines +165 to +168
Copy link
Contributor

Choose a reason for hiding this comment

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

From this description alone, I don't think I would be able to understand how to avoid this problem.

If you want to link to an issue or include an example of the bad code inline, that is fine.


Other `MemoryResource`s include:

* `FixedSizeMemoryResource` for allocating fixed blocks of memory
Expand Down