Add RMM User Guide

cpp/examples/README.md

@@ -5,3 +5,4 @@ This folder contains examples to demonstrate librmm use cases. Running `build.sh
 Current examples:
 
 - Basic: demonstrates memory resource construction and allocating a `device_uvector` on a stream.
+- Docs: code examples from the [user guide](../../docs/user_guide/), included via `literalinclude` directives.

cpp/examples/build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION.
+# SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION.
 # SPDX-License-Identifier: Apache-2.0
 
 # librmm examples build script
@@ -58,3 +58,4 @@ build_example() {
 }
 
 build_example basic
+build_example docs

cpp/examples/docs/CMakeLists.txt

@@ -0,0 +1,39 @@
+# cmake-format: off
+# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION.
+# SPDX-License-Identifier: Apache-2.0
+# cmake-format: on
+
+cmake_minimum_required(VERSION 3.30.4)
+
+include(../set_cuda_architecture.cmake)
+
+# initialize CUDA architectures
+rapids_cuda_init_architectures(docs_examples)
+
+project(
+  docs_examples
+  VERSION 0.0.1
+  LANGUAGES CXX CUDA)
+
+include(../fetch_dependencies.cmake)
+
+include(rapids-cmake)
+rapids_cmake_build_type("Release")
+
+# One executable per user guide page
+set(DOCS_CUDA_EXAMPLES guide stream_ordered_allocation managed_memory)
+set(DOCS_CXX_EXAMPLES introduction choosing_memory_resources logging installation)
+
+foreach(example ${DOCS_CUDA_EXAMPLES})
+  add_executable(docs_${example} src/${example}.cu)
+  target_link_libraries(docs_${example} PRIVATE rmm::rmm)
+  target_compile_features(docs_${example} PRIVATE cxx_std_17)
+  install(TARGETS docs_${example} DESTINATION bin/examples/librmm)
+endforeach()
+
+foreach(example ${DOCS_CXX_EXAMPLES})
+  add_executable(docs_${example} src/${example}.cpp)
+  target_link_libraries(docs_${example} PRIVATE rmm::rmm)
+  target_compile_features(docs_${example} PRIVATE cxx_std_17)
+  install(TARGETS docs_${example} DESTINATION bin/examples/librmm)
+endforeach()

cpp/examples/docs/src/choosing_memory_resources.cpp

@@ -0,0 +1,72 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// Code examples for docs/user_guide/choosing_memory_resources.md
+//
+// Include directives that appear inside function bodies are intentional:
+// they are no-ops (headers use #pragma once) and exist so that
+// literalinclude snippets display the includes alongside the code.
+
+#include <rmm/aligned.hpp>
+#include <rmm/cuda_device.hpp>
+#include <rmm/cuda_stream.hpp>
+#include <rmm/device_buffer.hpp>
+#include <rmm/mr/cuda_async_memory_resource.hpp>
+#include <rmm/mr/managed_memory_resource.hpp>
+#include <rmm/mr/pool_memory_resource.hpp>
+#include <rmm/mr/prefetch_resource_adaptor.hpp>
+
+#include <cassert>
+#include <iostream>
+
+void recommended_default()
+{
+  // clang-format off
+  // [recommended-default]
+  #include <rmm/mr/cuda_async_memory_resource.hpp>
+  #include <rmm/device_buffer.hpp>
+
+  rmm::mr::cuda_async_memory_resource mr;
+  rmm::cuda_stream stream;
+  rmm::device_buffer buffer(1024, stream.view(), mr);
+  // [/recommended-default]
+  // clang-format on
+
+  assert(buffer.size() == 1024);
+}
+
+void managed_pool_prefetch()
+{
+  // clang-format off
+  // [managed-pool-prefetch]
+  #include <rmm/mr/managed_memory_resource.hpp>
+  #include <rmm/mr/pool_memory_resource.hpp>
+  #include <rmm/mr/prefetch_resource_adaptor.hpp>
+  #include <rmm/aligned.hpp>
+  #include <rmm/cuda_device.hpp>
+
+  // Use 80% of GPU memory, rounded down to nearest 256 bytes
+  auto [free_memory, total_memory] = rmm::available_device_memory();
+  auto pool_size = rmm::align_down(static_cast<std::size_t>(total_memory * 0.8), 256);
+
+  rmm::mr::managed_memory_resource managed_mr;
+  rmm::mr::pool_memory_resource pool_mr{managed_mr, pool_size};
+  rmm::mr::prefetch_resource_adaptor prefetch_mr{pool_mr};
+  // [/managed-pool-prefetch]
+  // clang-format on
+
+  rmm::cuda_stream stream;
+  rmm::device_buffer buffer(1024, stream.view(), prefetch_mr);
+  assert(buffer.size() == 1024);
+}
+
+int main()
+{
+  recommended_default();
+  managed_pool_prefetch();
+
+  std::cout << "All choosing_memory_resources examples passed.\n";
+  return 0;
+}