Skip to content

Commit

Permalink
Cherry pick to rocm-rel-6.2: Fix some links to the rocBLAS memory all…
Browse files Browse the repository at this point in the history
…oc API (#803) (#808)

Fix some links to the rocBLAS memory alloc API (#803)

* Fix some links to the rocBLAS memory alloc API

* Wording changes
  • Loading branch information
amd-jnovotny authored Sep 6, 2024
1 parent b73f1f9 commit 61351c1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/howto/memory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Automatic workspace

By default, rocSOLVER will automatically allocate device memory to be used as internal workspace
using the rocBLAS memory model, and will increase the amount of allocated memory as needed by rocSOLVER functions. If this scheme is in use, the function ``rocblas_is_managing_device_memory`` will return
``true``. In order to re-enable this scheme if it is not in use, a ``nullptr`` or zero size can be passed to the helper functions ``rocblas_set_device_memory_size`` or ``rocblas_set_workspace``. For more details on these rocBLAS APIs, see `Device Memory Allocation Functions in rocBLAS`_.
``true``. In order to re-enable this scheme if it is not in use, a ``nullptr`` or zero size can be passed to the helper functions ``rocblas_set_device_memory_size`` or ``rocblas_set_workspace``. For more information about these rocBLAS APIs, see :doc:`Device Memory Allocation Functions in rocBLAS <rocblas:reference/memory-alloc>`.

This scheme has the disadvantage that automatic reallocation is synchronizing, and the user cannot control when this synchronization happens.

Expand All @@ -51,7 +51,7 @@ For example, the following code snippet will return the memory size required to
rocsolver_dgetrs(handle, rocblas_operation_none, 1024, 1, nullptr, lda, nullptr, nullptr, ldb);
rocblas_stop_device_memory_size_query(handle, &memory_size);
For more details on the rocBLAS APIs, see `Device Memory Allocation Functions in rocBLAS`_.
For more information about the rocBLAS APIs, see :doc:`Device Memory Allocation Functions in rocBLAS <rocblas:reference/memory-alloc>`.


Using an environment variable
Expand All @@ -74,7 +74,7 @@ recommended to first synchronize the handle stream if a rocSOLVER or rocBLAS rou
rocblas_set_device_memory_size(handle, memory_size);
For more details on the rocBLAS APIs, see `Device Memory Allocation Functions in rocBLAS`_.
For more information about the rocBLAS APIs, see :doc:`Device Memory Allocation Functions in rocBLAS <rocblas:reference/memory-alloc>`.

User-owned workspace
================================================
Expand All @@ -91,7 +91,7 @@ Finally, the user may opt to manage the workspace memory manually using HIP. By
rocblas_set_workspace(handle, nullptr, 0);
hipFree(device_memory);
For more details on the rocBLAS APIs, see `Device Memory Allocation Functions in rocBLAS`_.
For more information about the rocBLAS APIs, see :doc:`Device Memory Allocation Functions in rocBLAS <rocblas:reference/memory-alloc>`.

.. _the rocBLAS memory model: https://rocm.docs.amd.com/projects/rocBLAS/en/latest/API_Reference_Guide.html#device-memory-allocation-in-rocblas
.. _Device Memory Allocation Functions in rocBLAS: https://rocm.docs.amd.com/projects/rocBLAS/en/latest/API_Reference_Guide.html#device-memory-allocation-in-rocblas

0 comments on commit 61351c1

Please sign in to comment.