diff --git a/.gitignore b/.gitignore index e8084afe0..baf30c999 100644 --- a/.gitignore +++ b/.gitignore @@ -95,6 +95,7 @@ thirdparty/googletest/ ## Documentation cpp/doxygen/html +cpp/doxygen/latex cpp/doxygen/xml docs/_build diff --git a/conda/environments/all_cuda-129_arch-aarch64.yaml b/conda/environments/all_cuda-129_arch-aarch64.yaml index f35ace973..5b0be2fb3 100644 --- a/conda/environments/all_cuda-129_arch-aarch64.yaml +++ b/conda/environments/all_cuda-129_arch-aarch64.yaml @@ -22,6 +22,7 @@ dependencies: - identify>=2.5.20 - ipython - make +- myst-parser - nbsphinx - ninja - numba-cuda>=0.19.1,<0.20.0a0 @@ -30,6 +31,7 @@ dependencies: - numpydoc - packaging - pre-commit +- pydata-sphinx-theme>=0.15.4 - pytest-cov - pytest<9.0.0a0 - python>=3.10,<3.14 @@ -39,6 +41,6 @@ dependencies: - sphinx - sphinx-copybutton - sphinx-markdown-tables -- sphinx_rtd_theme +- sphinxcontrib-jquery - sysroot_linux-aarch64==2.28 name: all_cuda-129_arch-aarch64 diff --git a/conda/environments/all_cuda-129_arch-x86_64.yaml b/conda/environments/all_cuda-129_arch-x86_64.yaml index dc8ea7f73..8e3969c9e 100644 --- a/conda/environments/all_cuda-129_arch-x86_64.yaml +++ b/conda/environments/all_cuda-129_arch-x86_64.yaml @@ -22,6 +22,7 @@ dependencies: - identify>=2.5.20 - ipython - make +- myst-parser - nbsphinx - ninja - numba-cuda>=0.19.1,<0.20.0a0 @@ -30,6 +31,7 @@ dependencies: - numpydoc - packaging - pre-commit +- pydata-sphinx-theme>=0.15.4 - pytest-cov - pytest<9.0.0a0 - python>=3.10,<3.14 @@ -39,6 +41,6 @@ dependencies: - sphinx - sphinx-copybutton - sphinx-markdown-tables -- sphinx_rtd_theme +- sphinxcontrib-jquery - sysroot_linux-64==2.28 name: all_cuda-129_arch-x86_64 diff --git a/conda/environments/all_cuda-130_arch-aarch64.yaml b/conda/environments/all_cuda-130_arch-aarch64.yaml index 49581a6c8..43380e4bc 100644 --- a/conda/environments/all_cuda-130_arch-aarch64.yaml +++ b/conda/environments/all_cuda-130_arch-aarch64.yaml @@ -22,6 +22,7 @@ dependencies: - identify>=2.5.20 - ipython - make +- myst-parser - nbsphinx - ninja - numba-cuda>=0.19.1,<0.20.0a0 @@ -30,6 +31,7 @@ dependencies: - numpydoc - packaging - pre-commit +- pydata-sphinx-theme>=0.15.4 - pytest-cov - pytest<9.0.0a0 - python>=3.10,<3.14 @@ -39,6 +41,6 @@ dependencies: - sphinx - sphinx-copybutton - sphinx-markdown-tables -- sphinx_rtd_theme +- sphinxcontrib-jquery - sysroot_linux-aarch64==2.28 name: all_cuda-130_arch-aarch64 diff --git a/conda/environments/all_cuda-130_arch-x86_64.yaml b/conda/environments/all_cuda-130_arch-x86_64.yaml index d495610eb..0124a6303 100644 --- a/conda/environments/all_cuda-130_arch-x86_64.yaml +++ b/conda/environments/all_cuda-130_arch-x86_64.yaml @@ -22,6 +22,7 @@ dependencies: - identify>=2.5.20 - ipython - make +- myst-parser - nbsphinx - ninja - numba-cuda>=0.19.1,<0.20.0a0 @@ -30,6 +31,7 @@ dependencies: - numpydoc - packaging - pre-commit +- pydata-sphinx-theme>=0.15.4 - pytest-cov - pytest<9.0.0a0 - python>=3.10,<3.14 @@ -39,6 +41,6 @@ dependencies: - sphinx - sphinx-copybutton - sphinx-markdown-tables -- sphinx_rtd_theme +- sphinxcontrib-jquery - sysroot_linux-64==2.28 name: all_cuda-130_arch-x86_64 diff --git a/cpp/include/doxygen_groups.h b/cpp/include/doxygen_groups.h index 616acfddd..79ce708b2 100644 --- a/cpp/include/doxygen_groups.h +++ b/cpp/include/doxygen_groups.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: Copyright (c) 2023-2024, NVIDIA CORPORATION. + * SPDX-FileCopyrightText: Copyright (c) 2023-2025, NVIDIA CORPORATION. * SPDX-License-Identifier: Apache-2.0 */ @@ -17,6 +17,26 @@ // @ingroup tag to the API's doxygen comment. // Add a new group by first specifying in the hierarchy below. +/** + * @namespace rmm + * @brief RAPIDS Memory Manager - The top-level namespace for all RMM functionality + * + * The rmm namespace provides a comprehensive set of memory management + * utilities for CUDA applications, including memory resources, CUDA stream + * management, device-side data containers, and memory allocation utilities. + */ + +/** + * @namespace rmm::mr + * @brief Memory Resource classes and adaptors + * + * The rmm::mr namespace contains all base memory resource classes that + * implement various CUDA memory allocation strategies, adaptors for + * suballocation such as pool and arena adaptors, and adaptors that add + * functionality such as logging, alignment, and statistics tracking to + * existing memory resources. + */ + /** * @defgroup memory_resources Memory Resources * @{ diff --git a/dependencies.yaml b/dependencies.yaml index ead17e814..674ad8bb5 100644 --- a/dependencies.yaml +++ b/dependencies.yaml @@ -259,14 +259,16 @@ dependencies: - graphviz - ipython - make + - myst-parser - nbsphinx - &numba numba>=0.60.0,<0.62.0a0 - &numba_cuda numba-cuda>=0.19.1,<0.20.0a0 - numpydoc + - pydata-sphinx-theme>=0.15.4 - sphinx - - sphinx_rtd_theme - sphinx-copybutton - sphinx-markdown-tables + - sphinxcontrib-jquery py_version: specific: - output_types: conda diff --git a/docs/_static/RAPIDS-logo-purple.png b/docs/_static/RAPIDS-logo-purple.png new file mode 100644 index 000000000..d884e0137 Binary files /dev/null and b/docs/_static/RAPIDS-logo-purple.png differ diff --git a/docs/conf.py b/docs/conf.py index d0d957ae6..dd9f375d0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,18 +46,18 @@ # ones. extensions = [ - "sphinxcontrib.jquery", - "sphinx.ext.intersphinx", + "IPython.sphinxext.ipython_console_highlighting", + "IPython.sphinxext.ipython_directive", + "breathe", + "myst_parser", + "nbsphinx", + "numpydoc", "sphinx.ext.autodoc", "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", "sphinx_copybutton", - "numpydoc", "sphinx_markdown_tables", - "IPython.sphinxext.ipython_console_highlighting", - "IPython.sphinxext.ipython_directive", - "nbsphinx", - "recommonmark", - "breathe", + "sphinxcontrib.jquery", ] # Breathe Configuration @@ -95,14 +95,14 @@ # List of warnings to suppress suppress_warnings = [] -# if the file deprecated.xml does not exist in the doxygen xml output, -# breathe will fail to build the docs, so we conditionally add -# "deprecated.rst" to the exclude_patterns list +# If the file deprecated.xml does not exist in the Doxygen XML output, +# Breathe's deprecated page will fail. Conditionally exclude that page +# and suppress the resulting toctree warning. if not os.path.exists( os.path.join(breathe_projects["librmm"], "deprecated.xml") ): - exclude_patterns.append("librmm_docs/deprecated.rst") - suppress_warnings.append("toc.excluded") + exclude_patterns.append("cpp/deprecated.md") + suppress_warnings.append("toc.not_readable") # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" @@ -117,18 +117,34 @@ # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} +html_theme = "pydata_sphinx_theme" +html_logo = "_static/RAPIDS-logo-purple.png" + +html_theme_options = { + "external_links": [], + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/rapidsai/rmm", + "icon": "fa-brands fa-github", + "type": "fontawesome", + }, + { + "name": "X", + "url": "https://x.com/rapidsai", + "icon": "fa-brands fa-x-twitter", + "type": "fontawesome", + }, + ], + "show_toc_level": 1, + "navbar_align": "right", + "navigation_with_keys": True, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] +html_static_path = ["_static"] # -- Options for HTMLHelp output ------------------------------------------ @@ -300,7 +316,6 @@ def on_missing_reference(app, env, node, contnode): def setup(app): - app.add_js_file("copybutton_pydocs.js") app.add_css_file("https://docs.rapids.ai/assets/css/custom.css") app.add_js_file( "https://docs.rapids.ai/assets/js/custom.js", loading_method="defer" diff --git a/docs/cpp.rst b/docs/cpp.rst deleted file mode 100644 index e60f15129..000000000 --- a/docs/cpp.rst +++ /dev/null @@ -1,8 +0,0 @@ -Welcome to the rmm C++ documentation! -======================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - cpp_api.rst diff --git a/docs/cpp/cuda_device_management.md b/docs/cpp/cuda_device_management.md new file mode 100644 index 000000000..3992355a5 --- /dev/null +++ b/docs/cpp/cuda_device_management.md @@ -0,0 +1,6 @@ +# CUDA Device Management + +```{doxygengroup} cuda_device_management +:members: +:content-only: +``` diff --git a/docs/cpp/cuda_streams.md b/docs/cpp/cuda_streams.md new file mode 100644 index 000000000..43fd57336 --- /dev/null +++ b/docs/cpp/cuda_streams.md @@ -0,0 +1,6 @@ +# CUDA Streams + +```{doxygengroup} cuda_streams +:members: +:content-only: +``` diff --git a/docs/cpp/data_containers.md b/docs/cpp/data_containers.md new file mode 100644 index 000000000..2d829846e --- /dev/null +++ b/docs/cpp/data_containers.md @@ -0,0 +1,6 @@ +# Data Containers + +```{doxygengroup} data_containers +:members: +:content-only: +``` diff --git a/docs/cpp/errors.md b/docs/cpp/errors.md new file mode 100644 index 000000000..f35293085 --- /dev/null +++ b/docs/cpp/errors.md @@ -0,0 +1,6 @@ +# Errors + +```{doxygengroup} errors +:members: +:content-only: +``` diff --git a/docs/cpp/index.md b/docs/cpp/index.md new file mode 100644 index 000000000..4ef0edf41 --- /dev/null +++ b/docs/cpp/index.md @@ -0,0 +1,21 @@ +# C++ API + +This page documents the C++ API for RMM, also called `librmm`. + +```{toctree} +:maxdepth: 2 + +memory_resources/index +data_containers +thrust_integrations +cuda_device_management +cuda_streams +errors +utilities +rmm_namespace +``` + +## Indices and tables + +- {ref}`genindex` +- {ref}`search` diff --git a/docs/cpp/memory_resources/device_memory_resources.md b/docs/cpp/memory_resources/device_memory_resources.md new file mode 100644 index 000000000..2ab869c56 --- /dev/null +++ b/docs/cpp/memory_resources/device_memory_resources.md @@ -0,0 +1,7 @@ +# Device Memory Resources + +```{doxygengroup} device_memory_resources +:members: +:undoc-members: +:content-only: +``` diff --git a/docs/cpp/memory_resources/device_resource_adaptors.md b/docs/cpp/memory_resources/device_resource_adaptors.md new file mode 100644 index 000000000..a5723b0ea --- /dev/null +++ b/docs/cpp/memory_resources/device_resource_adaptors.md @@ -0,0 +1,6 @@ +# Device Resource Adaptors + +```{doxygengroup} device_resource_adaptors +:members: +:content-only: +``` diff --git a/docs/cpp/memory_resources/index.md b/docs/cpp/memory_resources/index.md new file mode 100644 index 000000000..bdf5a9840 --- /dev/null +++ b/docs/cpp/memory_resources/index.md @@ -0,0 +1,9 @@ +# Memory Resources + +```{toctree} +:maxdepth: 1 + +memory_resources +device_memory_resources +device_resource_adaptors +``` diff --git a/docs/cpp/memory_resources/memory_resources.md b/docs/cpp/memory_resources/memory_resources.md new file mode 100644 index 000000000..549cb09c4 --- /dev/null +++ b/docs/cpp/memory_resources/memory_resources.md @@ -0,0 +1,6 @@ +# Memory Resources + +```{doxygengroup} memory_resources +:members: +:content-only: +``` diff --git a/docs/cpp/rmm_namespace.md b/docs/cpp/rmm_namespace.md new file mode 100644 index 000000000..a6e267cdc --- /dev/null +++ b/docs/cpp/rmm_namespace.md @@ -0,0 +1,9 @@ +# Namespaces + +```{doxygennamespace} rmm +:desc-only: +``` + +```{doxygennamespace} rmm::mr +:desc-only: +``` diff --git a/docs/cpp/thrust_integrations.md b/docs/cpp/thrust_integrations.md new file mode 100644 index 000000000..7cf6989c0 --- /dev/null +++ b/docs/cpp/thrust_integrations.md @@ -0,0 +1,6 @@ +# Thrust Integrations + +```{doxygengroup} thrust_integrations +:members: +:content-only: +``` diff --git a/docs/cpp/utilities.md b/docs/cpp/utilities.md new file mode 100644 index 000000000..b2541296e --- /dev/null +++ b/docs/cpp/utilities.md @@ -0,0 +1,6 @@ +# Utilities + +```{doxygengroup} utilities +:members: +:content-only: +``` diff --git a/docs/cpp_api.rst b/docs/cpp_api.rst deleted file mode 100644 index 63e435190..000000000 --- a/docs/cpp_api.rst +++ /dev/null @@ -1,8 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - librmm_docs/index diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..d95428e72 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ +# RMM: RAPIDS Memory Manager + +RMM (RAPIDS Memory Manager) is a library for allocating and managing GPU memory in C++ and Python. + +```{toctree} +:maxdepth: 2 +:caption: Contents + +user_guide/guide +cpp/index +python/index +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 524351253..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. rmm documentation master file, created by - sphinx-quickstart on Thu Nov 19 13:16:00 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to rmm's documentation! -=============================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - Python - C++ - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/librmm_docs/cuda_device_management.rst b/docs/librmm_docs/cuda_device_management.rst deleted file mode 100644 index 096509886..000000000 --- a/docs/librmm_docs/cuda_device_management.rst +++ /dev/null @@ -1,5 +0,0 @@ -CUDA Device Management -====================== - -.. doxygengroup:: cuda_device_management - :members: diff --git a/docs/librmm_docs/cuda_streams.rst b/docs/librmm_docs/cuda_streams.rst deleted file mode 100644 index e3e6ed793..000000000 --- a/docs/librmm_docs/cuda_streams.rst +++ /dev/null @@ -1,5 +0,0 @@ -CUDA Streams -============ - -.. doxygengroup:: cuda_streams - :members: diff --git a/docs/librmm_docs/data_containers.rst b/docs/librmm_docs/data_containers.rst deleted file mode 100644 index 1cfccb7bd..000000000 --- a/docs/librmm_docs/data_containers.rst +++ /dev/null @@ -1,5 +0,0 @@ -Data Containers -=============== - -.. doxygengroup:: data_containers - :members: diff --git a/docs/librmm_docs/deprecated.rst b/docs/librmm_docs/deprecated.rst deleted file mode 100644 index b5ed90caa..000000000 --- a/docs/librmm_docs/deprecated.rst +++ /dev/null @@ -1,5 +0,0 @@ -Deprecated functionality -======================== - -.. doxygenpage:: deprecated - :content-only: diff --git a/docs/librmm_docs/errors.rst b/docs/librmm_docs/errors.rst deleted file mode 100644 index 4de0ee40a..000000000 --- a/docs/librmm_docs/errors.rst +++ /dev/null @@ -1,5 +0,0 @@ -Errors -====== - -.. doxygengroup:: errors - :members: diff --git a/docs/librmm_docs/index.rst b/docs/librmm_docs/index.rst deleted file mode 100644 index 2b61deb9f..000000000 --- a/docs/librmm_docs/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. rmm documentation master file, created by - sphinx-quickstart on Thu Nov 19 13:16:00 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -librmm Documentation -==================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - memory_resources - data_containers - thrust_integrations - cuda_device_management - cuda_streams - errors - logging - utilities - deprecated - - -.. doxygennamespace:: rmm - :desc-only: - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` diff --git a/docs/librmm_docs/logging.rst b/docs/librmm_docs/logging.rst deleted file mode 100644 index 97f961c0c..000000000 --- a/docs/librmm_docs/logging.rst +++ /dev/null @@ -1,5 +0,0 @@ -Logging -======= - -.. doxygengroup:: logging - :members: diff --git a/docs/librmm_docs/memory_resources.rst b/docs/librmm_docs/memory_resources.rst deleted file mode 100644 index 68d33f003..000000000 --- a/docs/librmm_docs/memory_resources.rst +++ /dev/null @@ -1,17 +0,0 @@ -Memory Resources -================ - -.. doxygennamespace:: rmm::mr - :desc-only: - -.. doxygengroup:: memory_resources - :members: - -.. doxygengroup:: device_memory_resources - :members: - -.. doxygengroup:: host_memory_resources - :members: - -.. doxygengroup:: device_resource_adaptors - :members: diff --git a/docs/librmm_docs/thrust_integrations.rst b/docs/librmm_docs/thrust_integrations.rst deleted file mode 100644 index 8574f482a..000000000 --- a/docs/librmm_docs/thrust_integrations.rst +++ /dev/null @@ -1,5 +0,0 @@ -Thrust Integration -================== - -.. doxygengroup:: thrust_integrations - :members: diff --git a/docs/librmm_docs/utilities.rst b/docs/librmm_docs/utilities.rst deleted file mode 100644 index 25b455746..000000000 --- a/docs/librmm_docs/utilities.rst +++ /dev/null @@ -1,5 +0,0 @@ -Utilities -============ - -.. doxygengroup:: utilities - :members: diff --git a/docs/python.rst b/docs/python.rst deleted file mode 100644 index bff919627..000000000 --- a/docs/python.rst +++ /dev/null @@ -1,9 +0,0 @@ -Welcome to the rmm Python documentation! -======================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - guide.md - python_api.rst diff --git a/docs/python/allocators.md b/docs/python/allocators.md new file mode 100644 index 000000000..eba939b6f --- /dev/null +++ b/docs/python/allocators.md @@ -0,0 +1,23 @@ +# rmm.allocators + +```{eval-rst} +.. automodule:: rmm.allocators.cupy + :members: + :undoc-members: + :show-inheritance: +``` + +```{eval-rst} +.. automodule:: rmm.allocators.numba + :members: + :inherited-members: + :undoc-members: + :show-inheritance: +``` + +```{eval-rst} +.. automodule:: rmm.allocators.torch + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python/index.md b/docs/python/index.md new file mode 100644 index 000000000..f2b671382 --- /dev/null +++ b/docs/python/index.md @@ -0,0 +1,14 @@ +# Python API + +This page documents the Python API for RMM, imported as the module `rmm`. + +```{toctree} +:maxdepth: 2 + +rmm +mr +allocators +statistics +pylibrmm +librmm +``` diff --git a/docs/python/librmm.md b/docs/python/librmm.md new file mode 100644 index 000000000..04630344b --- /dev/null +++ b/docs/python/librmm.md @@ -0,0 +1,10 @@ +# rmm.librmm + +This module contains internal C++ library bindings for RMM. Most users should not need to use this module directly. + +```{eval-rst} +.. automodule:: rmm.librmm + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python/mr.md b/docs/python/mr.md new file mode 100644 index 000000000..7812170f9 --- /dev/null +++ b/docs/python/mr.md @@ -0,0 +1,9 @@ +# rmm.mr (Memory Resources) + +```{eval-rst} +.. automodule:: rmm.mr + :members: + :inherited-members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python/pylibrmm.md b/docs/python/pylibrmm.md new file mode 100644 index 000000000..216680fb1 --- /dev/null +++ b/docs/python/pylibrmm.md @@ -0,0 +1,34 @@ +# rmm.pylibrmm + +This module contains the low-level Cython bindings for RMM. Some components from this module are re-exported through the top-level `rmm` module for convenience, while others are available only through this module. + +## Overview + +`rmm.pylibrmm` provides the Cython layer that wraps RMM's C++ functionality: + +- `DeviceBuffer` - GPU memory buffer (available as `rmm.DeviceBuffer`) +- `memory_resource` - Memory resource implementations (available as `rmm.mr`) +- Logging utilities (available through `rmm`) +- CUDA stream wrappers (documented below) + +## CUDA Stream Classes + +The stream classes are available only through `rmm.pylibrmm` and provide low-level CUDA stream management. + +### rmm.pylibrmm.stream + +```{eval-rst} +.. automodule:: rmm.pylibrmm.stream + :members: + :undoc-members: + :show-inheritance: +``` + +### rmm.pylibrmm.cuda_stream + +```{eval-rst} +.. automodule:: rmm.pylibrmm.cuda_stream + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python/rmm.md b/docs/python/rmm.md new file mode 100644 index 000000000..23e0e4afc --- /dev/null +++ b/docs/python/rmm.md @@ -0,0 +1,8 @@ +# rmm (top-level) + +```{eval-rst} +.. automodule:: rmm + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python/statistics.md b/docs/python/statistics.md new file mode 100644 index 000000000..c2fecb49f --- /dev/null +++ b/docs/python/statistics.md @@ -0,0 +1,9 @@ +# rmm.statistics + +```{eval-rst} +.. automodule:: rmm.statistics + :members: + :inherited-members: + :undoc-members: + :show-inheritance: +``` diff --git a/docs/python_api.rst b/docs/python_api.rst deleted file mode 100644 index 3ff0cb735..000000000 --- a/docs/python_api.rst +++ /dev/null @@ -1,57 +0,0 @@ -API Reference -============== - -Module Contents ---------------- - -.. automodule:: rmm - :members: - :undoc-members: - :show-inheritance: - - -Memory Resources ----------------- - -.. automodule:: rmm.mr - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - -Experimental Memory Resources ------------------------------- - -.. automodule:: rmm.mr.experimental - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - -Memory Allocators ------------------ - -.. automodule:: rmm.allocators.cupy - :members: - :undoc-members: - :show-inheritance: - -.. automodule:: rmm.allocators.numba - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - -.. automodule:: rmm.allocators.torch - :members: - :undoc-members: - :show-inheritance: - -Memory Statistics ------------------ - -.. automodule:: rmm.statistics - :members: - :inherited-members: - :undoc-members: - :show-inheritance: diff --git a/docs/guide.md b/docs/user_guide/guide.md similarity index 99% rename from docs/guide.md rename to docs/user_guide/guide.md index 95dbed594..ada03c7a9 100644 --- a/docs/guide.md +++ b/docs/user_guide/guide.md @@ -247,7 +247,7 @@ Common to both usages is that they modify the currently active RMM memory resour >>> import rmm >>> import rmm.statistics ->>> # We start with the default cuda memory resource +>>> # We start with the default CUDA memory resource >>> rmm.mr.get_current_device_resource() diff --git a/python/rmm/rmm/pylibrmm/memory_resource/_memory_resource.pyx b/python/rmm/rmm/pylibrmm/memory_resource/_memory_resource.pyx index a8d86a77f..da041c116 100644 --- a/python/rmm/rmm/pylibrmm/memory_resource/_memory_resource.pyx +++ b/python/rmm/rmm/pylibrmm/memory_resource/_memory_resource.pyx @@ -77,8 +77,8 @@ cdef class DeviceMemoryResource: def allocate(self, size_t nbytes, Stream stream=DEFAULT_STREAM): """Allocate ``nbytes`` bytes of memory. - Note - ---- + Notes + ----- On integrated memory systems, attempting to allocate more memory than available can cause the process to be killed by the operating system instead of raising a catchable :class:`MemoryError`.