diff --git a/docs/how-to/hip_programming_guide.rst b/docs/how-to/hip_programming_guide.rst new file mode 100644 index 000000000..efe7fd739 --- /dev/null +++ b/docs/how-to/hip_programming_guide.rst @@ -0,0 +1,55 @@ +.. meta:: + :description: HIP programming guide + :keywords: CU, CUs, number of CUs, compute units + +.. _hip-programming-guide: + +******************************************************************************** +HIP programming guide +******************************************************************************** + +The programming guide sections are the following: + +* :doc:`hip:understand/programming_model` + +* :doc:`hip:understand/hip_compilers` + +* :doc:`hip:how-to/hip_runtime_api` + + * :doc:`hip:how-to/hip_runtime_api/memory_management` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/host_memory` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/device_memory` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/device_memory/texture_fetching` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/coherence_control` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/unified_memory` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/virtual_memory` + + * :doc:`hip:how-to/hip_runtime_api/memory_management/stream_ordered_allocator` + + * :doc:`hip:how-to/hip_runtime_api/cooperative_groups` + + * :doc:`hip:how-to/hip_runtime_api/hipgraph` + +* :doc:`hip:reference/cpp_language_extensions` + + * :doc:`hip:reference/cpp_language_support` + +* :doc:`hip:understand/hardware_implementation` + +* :doc:`hip:how-to/performance_guidelines` + +* :doc:`hip:how-to/hip_porting_guide` + + * :doc:`hip:how-to/hip_porting_driver_api` + +* :doc:`hip:how-to/hip_rtc` + +* :doc:`hip:how-to/debugging` + +* :doc:`hip:how-to/logging` diff --git a/docs/index.md b/docs/index.md index 8500a91c9..7d56ae6f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,12 +13,8 @@ compatibility with industry software frameworks. For more information, see [What If you're using AMD Radeon™ PRO or Radeon GPUs in a workstation setting with a display connected, review {doc}`Radeon-specific ROCm documentation`. -Installation instructions are available from: - -* {doc}`ROCm installation for Linux` -* {doc}`HIP SDK installation for Windows` -* [Deep learning frameworks installation](./how-to/deep-learning-rocm.rst) -* [Build ROCm from source](./how-to/build-rocm.rst) +{doc}`HIP programming guide` serves as a model and interface guide +for ROCm. ROCm documentation is organized into the following categories: @@ -41,6 +37,7 @@ ROCm documentation is organized into the following categories: :::{grid-item-card} How to :class-body: rocm-card-banner rocm-hue-12 +* [Programming guide](./how-to/hip_programming_guide.rst) * [Using ROCm for AI](./how-to/rocm-for-ai/index.rst) * [Using ROCm for HPC](./how-to/rocm-for-hpc/index.rst) * [Fine-tuning LLMs and inference optimization](./how-to/llm-fine-tuning-optimization/index.rst) diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 117ea4872..aefc9dcf2 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -23,6 +23,8 @@ subtrees: - caption: How to entries: + - file: how-to/hip_programming_guide.rst + title: Programming guide - file: how-to/rocm-for-ai/index.rst title: Using ROCm for AI subtrees: diff --git a/docs/what-is-rocm.rst b/docs/what-is-rocm.rst index 4fca8fd16..4b9876404 100644 --- a/docs/what-is-rocm.rst +++ b/docs/what-is-rocm.rst @@ -149,5 +149,5 @@ Runtimes :header: "Component", "Description" ":doc:`AMD Common Language Runtime (CLR) `", "Contains source code for AMD's common language runtimes: HIP and OpenCL" - ":doc:`HIP `", "AMD's GPU programming language extension and the GPU runtime" + ":doc:`HIP `", "C++ runtime API and kernel language that lets developers create portable applications for AMD and NVIDIA GPUs from single source code." ":doc:`ROCR-Runtime `", "User-mode API interfaces and libraries necessary for host applications to launch compute kernels on available HSA ROCm kernel agents"