Skip to content

Commit

Permalink
Minor fix
Browse files Browse the repository at this point in the history
  • Loading branch information
neon60 committed Nov 24, 2024
1 parent 1f7e5bf commit 708f19a
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 7 deletions.
2 changes: 2 additions & 0 deletions docs/how-to/hip_runtime_api/error_handling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
:description: Error Handling
:keywords: AMD, ROCm, HIP, error handling, error

.. _error_handling:

********************************************************************************
Error handling
********************************************************************************
Expand Down
6 changes: 3 additions & 3 deletions docs/how-to/hip_runtime_api/external_interop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Semaphore functions ensure smooth operation, preventing conflicts and
maintaining the integrity of processes; upholding the integrity and performance
of concurrent processes.

External semaphore functions can be used in HIP as described in :doc:`../reference/hip_runtime_api/external_interop`.
External semaphore functions can be used in HIP as described in :ref:`external_resource_interoperability_reference`.

Memory Functions
===============================================================================
Expand Down Expand Up @@ -83,8 +83,8 @@ cross-API manner.
.. <!-- spellcheck-disable -->
.. literalinclude:: ../../tools/example_codes/external_interop.hip
:start-after: // [Sphinx semaphore convert start]
:end-before: // [Sphinx semaphore convert end]
:start-after: // [Sphinx semaphore import start]
:end-before: // [Sphinx semaphore import end]
:language: cpp

.. <!-- spellcheck-enable -->
Expand Down
2 changes: 2 additions & 0 deletions docs/how-to/hip_runtime_api/initialization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
:description: Initialization.
:keywords: AMD, ROCm, HIP, initialization

.. _initialization:

********************************************************************************
Initialization
********************************************************************************
Expand Down
2 changes: 2 additions & 0 deletions docs/how-to/hip_runtime_api/memory_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
:description: Memory management and its usage
:keywords: AMD, ROCm, HIP, CUDA, memory management

.. _memory_management:

********************************************************************************
Memory management
********************************************************************************
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/hip_runtime_api/multi_device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ or the most energy-efficient option.
return 0;
}
.. _multi-device_selection:
.. _multi_device_selection:

Device selection
===============================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/performance_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ the host or parallel to the devices.

For parallel workloads, when threads belonging to the same block need to
synchronize to share data, use :cpp:func:`__syncthreads()` (see:
:ref:`synchronization functions`) within the same kernel invocation. For threads
:ref:`synchronization_functions`) within the same kernel invocation. For threads
belonging to different blocks, use global memory with two separate
kernel invocations. It is recommended to avoid the latter approach as it adds
overhead.
Expand Down
4 changes: 4 additions & 0 deletions docs/programming_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,13 @@ returned values, in order to catch and handle those errors, if possible.
An exception is kernel launches, which don't return any value. These
errors can be caught with specific functions like :cpp:func:`hipGetLastError()`.

For more information, see :ref:`error_handling` .

Multi-GPU and Load Balancing
================================================================================

Large-scale applications that need more compute power can use multiple GPUs in
the system. This requires distributing workloads across multiple GPUs to balance
the load to prevent GPUs from being overutilized while others are idle.

For more information, see :ref:`multi-device` .
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ The structs, define macros, enums and files in the HIP runtime API.

* :ref:`global_enum_defines_reference`
* :ref:`driver_types_reference`
* :doc:`hip:doxygen/html/annotated`
* :doc:`hip:doxygen/html/files`
* :doc:`../../doxygen/html/annotated`
* :doc:`../../doxygen/html/files`

0 comments on commit 708f19a

Please sign in to comment.