derek.holloway
7502bf64a4
3.4 KiB
HIP documentation
HIP is a C++ runtime API and kernel programming language designed for AMD GPUs. By providing an interface closely aligned with NVIDIA CUDA, HIP allows developers to write portable applications and efficiently migrate existing CUDA code to AMD platforms. Additional information is available in What is HIP?
Developers who require a unified, book‑style reference for ROCm and HIP can consult the AMD ROCm Programming Guide. It aggregates documentation from the ROCm portal and organizes it into a structured format optimized for in‑depth study and offline access in both PDF and HTML. Additional details are available in the AMD ROCm Programming Guide.
HIP API 7.0 introduces changes to make it align more closely with NVIDIA CUDA.
These changes are incompatible with prior releases, and might require recompiling
existing HIP applications for use with the ROCm 7.0 release. For more information,
see [HIP API 7.0 changes](./hip-7-changes).
Installation instructions are available from:
The HIP documentation is organized into the following categories:
::::{grid} 1 2 2 2 :gutter: 3
:::{grid-item-card} Programming guide
- {doc}
./understand/programming_model - {doc}
./understand/performance_optimization - {doc}
./understand/hardware_implementation - {doc}
./understand/compilers - {doc}
./how-to/performance_guidelines - Debugging with HIP
- {doc}
./how-to/logging - {doc}
./how-to/hip_runtime_api - {doc}
./how-to/hip_cpp_language_extensions - {doc}
./how-to/kernel_language_cpp_support - {doc}
./how-to/hip_porting_guide - {doc}
./how-to/hip_rtc - {doc}
./understand/amd_clr - {doc}
./how-to/hipDeviceProperties
:::
:::{grid-item-card} Reference
- HIP runtime API
- HIP math API
- HIP complex math API
- HIP environment variables
- HIP error codes
- NVIDIA CUDA to HIP API Function Comparison
- List of deprecated APIs
- Low Precision Floating Point Types
- {doc}
./reference/hardware_features
:::
:::{grid-item-card} Tutorial
- HIP basic examples
- HIP examples
- SAXPY tutorial
- GPU programming patterns
- Reduction tutorial
- Cooperative groups tutorial
- HIP Graph API tutorial
:::
::::
Known issues are listed on the HIP GitHub repository.
To contribute features or functions to the HIP project, refer to Contributing to HIP.
To contribute to the documentation, refer to {doc}Contributing to ROCm docs <rocm:contribute/contributing> page.
You can find licensing information on the Licensing page.