Add asynchronous execution documentation page

ROCm · Dec 19, 2024 · 998bb48 · 998bb48
1 parent 25cf96e
commit 998bb48
Show file tree

Hide file tree

Showing 7 changed files with 798 additions and 5 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -7,7 +7,7 @@ APUs
 AQL
 AXPY
 asm
-Asynchrony
+asynchrony
 backtrace
 Bitcode
 bitcode
@@ -124,6 +124,7 @@ overindexing
 oversubscription
 overutilized
 parallelizable
+parallelized
 pixelated
 pragmas
 preallocated

diff --git a/docs/data/how-to/hip_runtime_api/asynchronous/sequential_async_event.drawio b/docs/data/how-to/hip_runtime_api/asynchronous/sequential_async_event.drawio
diff --git a/docs/data/how-to/hip_runtime_api/asynchronous/sequential_async_event.svg b/docs/data/how-to/hip_runtime_api/asynchronous/sequential_async_event.svg
diff --git a/docs/how-to/hip_runtime_api.rst b/docs/how-to/hip_runtime_api.rst
@@ -40,6 +40,7 @@ Here are the various HIP Runtime API high level functions:
 * :doc:`./hip_runtime_api/initialization`
 * :doc:`./hip_runtime_api/memory_management`
 * :doc:`./hip_runtime_api/error_handling`
+* :doc:`./hip_runtime_api/asynchronous`
 * :doc:`./hip_runtime_api/cooperative_groups`
 * :doc:`./hip_runtime_api/hipgraph`
 * :doc:`./hip_runtime_api/call_stack`

diff --git a/docs/how-to/hip_runtime_api/asynchronous.rst b/docs/how-to/hip_runtime_api/asynchronous.rst
diff --git a/docs/how-to/performance_guidelines.rst b/docs/how-to/performance_guidelines.rst
@@ -3,6 +3,8 @@
    developers optimize the performance of HIP-capable GPU architectures.
   :keywords: AMD, ROCm, HIP, CUDA, performance, guidelines
 
+.. _how_to_performance_guidelines:
+
 *******************************************************************************
 Performance guidelines
 *******************************************************************************
@@ -32,12 +34,14 @@ reveal and efficiently provide as much parallelism as possible. The parallelism
 can be performed at the application level, device level, and multiprocessor
 level.
 
+.. _application_parallel_execution:
+
 Application level
 --------------------------------------------------------------------------------
 
 To enable parallel execution of the application across the host and devices, use
-asynchronous calls and streams. Assign workloads based on efficiency: serial to
-the host or parallel to the devices.
+:ref:`asynchronous calls and streams <asynchronous_how-to>`. Assign workloads
+based on efficiency: serial to 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:

diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -49,9 +49,10 @@ subtrees:
           - file: how-to/hip_runtime_api/memory_management/virtual_memory
           - file: how-to/hip_runtime_api/memory_management/stream_ordered_allocator
       - file: how-to/hip_runtime_api/error_handling
-      - file: how-to/hip_runtime_api/cooperative_groups
-      - file: how-to/hip_runtime_api/hipgraph
       - file: how-to/hip_runtime_api/call_stack
+      - file: how-to/hip_runtime_api/asynchronous
+      - file: how-to/hip_runtime_api/hipgraph
+      - file: how-to/hip_runtime_api/cooperative_groups
       - file: how-to/hip_runtime_api/multi_device
       - file: how-to/hip_runtime_api/opengl_interop
       - file: how-to/hip_runtime_api/external_interop