Skip to content

Commit 94d95be

Browse files
authored
Clarify using RMM with other Python libraries (rapidsai#1034)
Based on an internal question, clarified the README docs on what the APIs for enabling cuPy/Numba to use RMM simply inherit whatever the state of RMM is as opposed to modify the state (like enabling a memory pool). Authors: - Jake Hemstad (https://github.com/jrhemstad) - Ashwin Srinath (https://github.com/shwina) Approvers: - Bradley Dice (https://github.com/bdice) - Mark Harris (https://github.com/harrism) URL: rapidsai#1034
1 parent 4e8bca5 commit 94d95be

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -684,6 +684,11 @@ allocations by setting the CuPy CUDA allocator to
684684
>>> cupy.cuda.set_allocator(rmm.rmm_cupy_allocator)
685685
```
686686

687+
688+
**Note:** This only configures CuPy to use the current RMM resource for allocations.
689+
It does not initialize nor change the current resource, e.g., enabling a memory pool.
690+
See [here](#memoryresource-objects) for more information on changing the current memory resource.
691+
687692
### Using RMM with Numba
688693

689694
You can configure Numba to use RMM for memory allocations using the
@@ -704,3 +709,7 @@ This can be done in two ways:
704709
>>> import rmm
705710
>>> cuda.set_memory_manager(rmm.RMMNumbaManager)
706711
```
712+
713+
**Note:** This only configures Numba to use the current RMM resource for allocations.
714+
It does not initialize nor change the current resource, e.g., enabling a memory pool.
715+
See [here](#memoryresource-objects) for more information on changing the current memory resource.

0 commit comments

Comments
 (0)