diff --git a/projects/hip/CONTRIBUTING.md b/projects/hip/CONTRIBUTING.md index a63e03da67..026c335459 100644 --- a/projects/hip/CONTRIBUTING.md +++ b/projects/hip/CONTRIBUTING.md @@ -23,7 +23,7 @@ Please use the [GitHub Issue](https://github.com/ROCm/HIP/issues) tab to notify ## Acceptance Criteria ## -HIP is a C++ Runtime API and Kernel Language that allows developers to create portable applications for AMD and NVIDIA GPUs from single source code. Contributors wishing to submit new HIP Features (ie functions, classes, types) should also consider CUDA APIs. +HIP is a C++ Runtime API and Kernel Language that allows developers to create portable applications for AMD and NVIDIA GPUs from single source code. Contributors wishing to submit new HIP Features (ie functions, classes, types) should resemble CUDA APIs. Differences or limitations of HIP APIs as compared to CUDA APIs should be clearly documented and described. Some guidelines are outlined below: @@ -51,6 +51,7 @@ For applications and benchmarks outside the hip-tests environment, developments - Use 4 spaces indentation. - Capitalization and Naming - Prefer camelCase for HIP interfaces and internal symbols. Note HCC uses _ for separator. + This guideline is not yet consistently followed in HIP code - eventual compliance is aspirational. - Member variables should begin with a leading "_". This allows them to be easily distinguished from other variables or functions. - `{}` placement diff --git a/projects/hip/docs/data/understand/programming_model/cdna2_gcd.png b/projects/hip/docs/data/hardware_implementation/cdna2_gcd.png similarity index 100% rename from projects/hip/docs/data/understand/programming_model/cdna2_gcd.png rename to projects/hip/docs/data/hardware_implementation/cdna2_gcd.png diff --git a/projects/hip/docs/data/understand/programming_model/cdna3_cu.png b/projects/hip/docs/data/hardware_implementation/cdna3_cu.png similarity index 100% rename from projects/hip/docs/data/understand/programming_model/cdna3_cu.png rename to projects/hip/docs/data/hardware_implementation/cdna3_cu.png diff --git a/projects/hip/docs/data/hardware_implementation/compute_unit.drawio b/projects/hip/docs/data/hardware_implementation/compute_unit.drawio new file mode 100644 index 0000000000..3e1d18a8a8 --- /dev/null +++ b/projects/hip/docs/data/hardware_implementation/compute_unit.drawio @@ -0,0 +1,187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/projects/hip/docs/data/hardware_implementation/compute_unit.svg b/projects/hip/docs/data/hardware_implementation/compute_unit.svg new file mode 100644 index 0000000000..49adbc8e45 --- /dev/null +++ b/projects/hip/docs/data/hardware_implementation/compute_unit.svg @@ -0,0 +1,4 @@ + + + +Compute Unit
Vector Caches
Vector Caches
SIMD 0
SIMD 0
Vector ALU
Vector ALU
Vector
Register
File
Vector...
SIMD 2
SIMD 2
Vector ALU
Vector ALU
Vector
Register
File
Vector...
SIMD 3
SIMD 3
Vector ALU
Vector ALU
Vector
Register
File
Vector...
SIMD 1
SIMD 1
Vector ALU
Vector ALU
Vector
Register
File
Vector...
Scalar ALU
Scalar ALU
Scalar Unit
Scalar Unit
Scalar
Register
File
Scalar...
Local Data Share
Local Data Share
Text is not SVG - cannot display
\ No newline at end of file diff --git a/projects/hip/docs/data/understand/programming_model/rdna3_cu.png b/projects/hip/docs/data/hardware_implementation/rdna3_cu.png similarity index 100% rename from projects/hip/docs/data/understand/programming_model/rdna3_cu.png rename to projects/hip/docs/data/hardware_implementation/rdna3_cu.png diff --git a/projects/hip/docs/data/reference/programming_model/memory_hierarchy.drawio b/projects/hip/docs/data/programming_model/reference/memory_hierarchy.drawio similarity index 100% rename from projects/hip/docs/data/reference/programming_model/memory_hierarchy.drawio rename to projects/hip/docs/data/programming_model/reference/memory_hierarchy.drawio diff --git a/projects/hip/docs/data/reference/programming_model/memory_hierarchy.svg b/projects/hip/docs/data/programming_model/reference/memory_hierarchy.svg similarity index 100% rename from projects/hip/docs/data/reference/programming_model/memory_hierarchy.svg rename to projects/hip/docs/data/programming_model/reference/memory_hierarchy.svg diff --git a/projects/hip/docs/data/reference/programming_model/thread_hierarchy.drawio b/projects/hip/docs/data/programming_model/reference/thread_hierarchy.drawio similarity index 100% rename from projects/hip/docs/data/reference/programming_model/thread_hierarchy.drawio rename to projects/hip/docs/data/programming_model/reference/thread_hierarchy.drawio diff --git a/projects/hip/docs/data/reference/programming_model/thread_hierarchy.svg b/projects/hip/docs/data/programming_model/reference/thread_hierarchy.svg similarity index 100% rename from projects/hip/docs/data/reference/programming_model/thread_hierarchy.svg rename to projects/hip/docs/data/programming_model/reference/thread_hierarchy.svg diff --git a/projects/hip/docs/data/reference/programming_model/thread_hierarchy_coop.drawio b/projects/hip/docs/data/programming_model/reference/thread_hierarchy_coop.drawio similarity index 100% rename from projects/hip/docs/data/reference/programming_model/thread_hierarchy_coop.drawio rename to projects/hip/docs/data/programming_model/reference/thread_hierarchy_coop.drawio diff --git a/projects/hip/docs/data/reference/programming_model/thread_hierarchy_coop.svg b/projects/hip/docs/data/programming_model/reference/thread_hierarchy_coop.svg similarity index 100% rename from projects/hip/docs/data/reference/programming_model/thread_hierarchy_coop.svg rename to projects/hip/docs/data/programming_model/reference/thread_hierarchy_coop.svg diff --git a/projects/hip/docs/data/programming_model/understand/cdna2_gcd.png b/projects/hip/docs/data/programming_model/understand/cdna2_gcd.png new file mode 100644 index 0000000000..4344d7c81a Binary files /dev/null and b/projects/hip/docs/data/programming_model/understand/cdna2_gcd.png differ diff --git a/projects/hip/docs/data/programming_model/understand/cdna3_cu.png b/projects/hip/docs/data/programming_model/understand/cdna3_cu.png new file mode 100644 index 0000000000..a1917adc5f Binary files /dev/null and b/projects/hip/docs/data/programming_model/understand/cdna3_cu.png differ diff --git a/projects/hip/docs/data/programming_model/understand/cdna3_cu_dark.png b/projects/hip/docs/data/programming_model/understand/cdna3_cu_dark.png new file mode 100644 index 0000000000..3fada0d43f Binary files /dev/null and b/projects/hip/docs/data/programming_model/understand/cdna3_cu_dark.png differ diff --git a/projects/hip/docs/data/programming_model/understand/rdna3_cu.drawio b/projects/hip/docs/data/programming_model/understand/rdna3_cu.drawio new file mode 100644 index 0000000000..e69de29bb2 diff --git a/projects/hip/docs/data/programming_model/understand/rdna3_cu.png b/projects/hip/docs/data/programming_model/understand/rdna3_cu.png new file mode 100644 index 0000000000..2d38d2a508 Binary files /dev/null and b/projects/hip/docs/data/programming_model/understand/rdna3_cu.png differ diff --git a/projects/hip/docs/data/understand/programming_model/simt.drawio b/projects/hip/docs/data/programming_model/understand/simt.drawio similarity index 100% rename from projects/hip/docs/data/understand/programming_model/simt.drawio rename to projects/hip/docs/data/programming_model/understand/simt.drawio diff --git a/projects/hip/docs/data/understand/programming_model/simt.svg b/projects/hip/docs/data/programming_model/understand/simt.svg similarity index 100% rename from projects/hip/docs/data/understand/programming_model/simt.svg rename to projects/hip/docs/data/programming_model/understand/simt.svg