Add Cooperative Groups reference, how-to and tutorial

ROCm · Aug 1, 2024 · 955c344 · 955c344
1 parent 1a58096
commit 955c344
Show file tree

Hide file tree

Showing 17 changed files with 1,830 additions and 107 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -24,8 +24,8 @@ build:
      post_checkout:
        - if [ -d ../clr ]; then rm -rf ../clr; fi
        - if [ -d ../ROCR-Runtime ]; then rm -rf ../ROCR-Runtime; fi
-       - git clone --depth=1 --single-branch --branch docs/develop    https://github.com/ROCm/clr.git ../clr
-       - git clone --depth=1 --single-branch --branch master     https://github.com/ROCm/ROCR-Runtime.git ../ROCR-Runtime
+       - git clone --depth=1 --single-branch --branch docs/develop https://github.com/ROCm/clr.git ../clr
+       - git clone --depth=1 --single-branch --branch master       https://github.com/ROCm/ROCR-Runtime.git ../ROCR-Runtime
      post_build:
        - rm -rf ../clr
        - rm -rf ../ROCR-Runtime
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -19,6 +19,7 @@ cuCtx
 cuDNN
 dataflow
 deallocate
+decompositions
 denormal
 Dereferencing
 dll
@@ -107,6 +108,7 @@ structs
 SYCL
 syntaxes
 tradeoffs
+templated
 typedefs
 UMM
 variadic

diff --git a/docs/conf.py b/docs/conf.py
@@ -46,3 +46,9 @@
 suppress_warnings = ["etoc.toctree"]
 
 numfig = False
+
+
+exclude_patterns = [
+    "doxygen/mainpage.md",
+    "understand/glossary.md"
+]
diff --git a/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_bottom.drawio b/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_bottom.drawio
diff --git a/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_bottom.svg b/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_bottom.svg
diff --git a/...el_reference/thread_hierarchy_coop.drawio → ...e_groups/thread_hierarchy_coop_top.drawio b/...el_reference/thread_hierarchy_coop.drawio → ...e_groups/thread_hierarchy_coop_top.drawio
diff --git a/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_top.svg b/docs/data/how-to/cooperative_groups/thread_hierarchy_coop_top.svg
diff --git a/docs/data/understand/programming_model_reference/thread_hierarchy_coop.svg b/docs/data/understand/programming_model_reference/thread_hierarchy_coop.svg
diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -833,6 +833,7 @@ INPUT                  = mainpage.md \
                          ../../include/hip \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_hip_gl_interop.h \
                          ../../../clr/hipamd/include/hip/amd_detail/amd_surface_functions.h \
+                         ../../../clr/hipamd/include/hip/amd_detail/amd_hip_cooperative_groups.h \
                          ../../../ROCR-Runtime/src/inc/hsa_ext_amd.h
 
 # This tag can be used to specify the character encoding of the source files
@@ -2196,14 +2197,17 @@ INCLUDE_FILE_PATTERNS  =
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 PREDEFINED             = "__HIP_PLATFORM_AMD__" \
+                         "DOXYGEN_SHOULD_INCLUDE_THIS=1" \
+                         "DOXYGEN_SHOULD_SKIP_THIS=1" \
                          "__dparm(x)=" \
                          "__cplusplus=201103L" \
                          "__host__=" \
                          "__device__=" \
                          "__hip_img_chk__=" \
                          "__CG_QUALIFIER__=" \
                          "__CG_STATIC_QUALIFIER__=static" \
-                         "_CG_STATIC_CONST_DECL_=static constexpr"
+                         "_CG_STATIC_CONST_DECL_=static constexpr" \
+                         "HIP_ENABLE_WARP_SYNC_BUILTINS"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The