docs: add developer guide on memory management with RMM #7174

susmnty · 2025-09-04T16:00:27Z

have done the documentation in the basic of understanding and the workflow, feel free to make changes.

copy-pr-bot · 2025-09-04T16:00:30Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

csadorf · 2025-09-04T16:44:14Z

docs/source/developer_guide/memory_management.rst

+
+- **Memory leaks**: forgetting to free memory after use.
+- **Dangling pointers**: using freed memory by mistake.
+- **Incompatibility**: does not integrate well with=========================================


syntax error

csadorf · 2025-09-04T16:48:50Z

docs/source/developer_guide/memory_management.rst

+Raw Allocation vs. RMM
+----------------------
+**❌ Raw Allocation Example:**
+.. code-block:: cpp


please review this in the github preview; this doesn't render correctly

csadorf · 2025-09-04T16:50:29Z

docs/source/developer_guide/memory_management.rst

+Migration Strategy
+------------------
+When contributing to cuML:


Does this apply to new contributions? Or a migration effort? This seems unclear.

csadorf · 2025-09-04T16:51:36Z

docs/source/developer_guide/memory_management.rst

Overall this seems a bit overly verbose. I would prefer this to be a bit more concise and tailored to the specific needs of the cuML project. We should avoid duplicating the RMM docs and instead refer to those where appropriate.

Thanks for the feedback! I’ve simplified the documentation to avoid duplication with RMM, kept it cuML-specific, and added a reference link to the RMM docs. Please let me know if further adjustments are needed.

csadorf · 2025-09-05T14:27:09Z

Thanks for addressing my comments.

Quick note: please do not merge the upstream branch unless this branch is significantly out of date. It unnecessarily increases our Ci worker load.

csadorf

Please make sure to integrate this guide with wiki/cpp/DEVELOPER_GUIDE.md .

into docs-memory-allocation

susmnty · 2025-09-05T19:13:32Z

Thanks for the feedback! I’ve integrated the memory management guide into wiki/cpp/DEVELOPER_GUIDE.md as requested. Also noted about not merging upstream unless the branch is significantly out of date - I’ll keep that in mind going forward. This should now be ready for another review.

susmnty · 2025-09-05T19:15:06Z

quite sorry again for the unnecessary clicking of the update branch, noted I wont press it again the branch is actually out of the date.

…IDE.md

csadorf · 2025-09-05T20:50:12Z

Thanks for the feedback! I’ve integrated the memory management guide into wiki/cpp/DEVELOPER_GUIDE.md as requested. Also noted about not merging upstream unless the branch is significantly out of date - I’ll keep that in mind going forward. This should now be ready for another review.

Please actually integrate it rather than linking to it. Thanks!

susmnty · 2025-09-06T03:49:04Z

Thanks for the feedback! I’ve now integrated the memory management content directly into DEVELOPER_GUIDE.md instead of linking out. Please let me know if there are any further adjustments needed.

csadorf

LGTM

bdice

I have some suggestions for improvement. More generally I am unsure about the duplication of information.

bdice · 2025-09-30T16:36:49Z

docs/source/developer_guide/memory_management.rst

+
+When contributing to cuML:
+
+- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.


Suggested change

- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.

- Use RMM containers instead of raw ``cudaMalloc``/``cudaFree``.

bdice · 2025-09-30T16:36:57Z

docs/source/developer_guide/memory_management.rst

+When contributing to cuML:
+
+- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.
+- Prefer ``device_uvector`` for typed data.


Suggested change

- Prefer ``device_uvector`` for typed data.

- Prefer ``rmm::device_uvector<T>`` for typed data.

bdice · 2025-09-30T16:37:29Z

docs/source/developer_guide/memory_management.rst

+
+- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.
+- Prefer ``device_uvector`` for typed data.
+- Refer to the official `RMM documentation <https://github.com/rapidsai/rmm>`_ for advanced features.


Suggested change

- Refer to the official `RMM documentation <https://github.com/rapidsai/rmm>`_ for advanced features.

- Refer to the `RMM documentation <https://docs.rapids.ai/api/rmm/>`_ or `RMM repository <https://docs.rapids.ai/api/rmm/>`_ for more information.

bdice · 2025-09-30T16:38:47Z

wiki/cpp/DEVELOPER_GUIDE.md

    thrust::for_each(execution_policy->on(stream), ... );
 }
 ```
+## Memory Management in cuML


Should we have duplicate information? It seems like we have two developer guides. What is the difference between them? Maybe a question for @csadorf @dantegd.

Considering the information density, we should just integrate everything into this document. We should also be careful in duplicating information from the RMM docs and instead refer to them where possible.

csadorf · 2025-09-30T16:43:14Z

wiki/cpp/DEVELOPER_GUIDE.md

    thrust::for_each(execution_policy->on(stream), ... );
 }
 ```
+## Memory Management in cuML


Considering the information density, we should just integrate everything into this document. We should also be careful in duplicating information from the RMM docs and instead refer to them where possible.

csadorf · 2025-09-30T16:44:22Z

I'm retargeting this for 25.12.

docs: add developer guide on memory management with RMM

89127b0

csadorf added doc Documentation non-breaking Non-breaking change labels Sep 4, 2025

csadorf reviewed Sep 4, 2025

View reviewed changes

docs: simplify memory management guide as per review feedback

949ecab

susmnty force-pushed the docs-memory-allocation branch from ddddc64 to 949ecab Compare September 5, 2025 03:51

Merge branch 'branch-25.10' into docs-memory-allocation

511b9f0

csadorf requested changes Sep 5, 2025

View reviewed changes

susmnty added 2 commits September 6, 2025 00:39

Integrate memory management guide reference into DEVELOPER_GUIDE.md

d31cacf

Merge branch 'docs-memory-allocation' of https://github.com/susmnty/cuml

b0aa52e

into docs-memory-allocation

susmnty requested a review from a team as a code owner September 5, 2025 19:11

susmnty requested a review from divyegala September 5, 2025 19:11

Merge branch 'branch-25.10' into docs-memory-allocation

ee1ba9d

updated Integrate memory management guide reference into DEVELOPER_GU…

985cbdd

…IDE.md

Docs: Integrate memory management guide directly into DEVELOPER_GUIDE.md

e6b160f

susmnty and others added 2 commits September 6, 2025 11:55

Update DEVELOPER_GUIDE.md

5609a34

Merge branch 'branch-25.10' into docs-memory-allocation

4b32722

csadorf assigned susmnty Sep 15, 2025

csadorf approved these changes Sep 15, 2025

View reviewed changes

Merge branch 'branch-25.10' into docs-memory-allocation

dc11afe

bdice reviewed Sep 30, 2025

View reviewed changes

csadorf requested changes Sep 30, 2025

View reviewed changes

csadorf changed the base branch from branch-25.10 to branch-25.12 September 30, 2025 16:44


		When contributing to cuML:

		- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.

	- Replace raw ``cudaMalloc/cudaFree`` with RMM containers.
	- Use RMM containers instead of raw ``cudaMalloc``/``cudaFree``.

	- Prefer ``device_uvector`` for typed data.
	- Prefer ``rmm::device_uvector<T>`` for typed data.

	- Refer to the official `RMM documentation <https://github.com/rapidsai/rmm>`_ for advanced features.
	- Refer to the `RMM documentation <https://docs.rapids.ai/api/rmm/>`_ or `RMM repository <https://docs.rapids.ai/api/rmm/>`_ for more information.

docs: add developer guide on memory management with RMM #7174

Are you sure you want to change the base?

docs: add developer guide on memory management with RMM #7174

Uh oh!

Conversation

susmnty commented Sep 4, 2025

Uh oh!

copy-pr-bot bot commented Sep 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csadorf commented Sep 5, 2025

Uh oh!

csadorf left a comment

Choose a reason for hiding this comment

Uh oh!

susmnty commented Sep 5, 2025

Uh oh!

susmnty commented Sep 5, 2025

Uh oh!

csadorf commented Sep 5, 2025

Uh oh!

susmnty commented Sep 6, 2025

Uh oh!

csadorf left a comment

Choose a reason for hiding this comment

Uh oh!

bdice left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csadorf commented Sep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants