2024-12-15 19:31:35 +01:00
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="description" content="HIP documentation and programming guide.">
|
|
|
|
|
<meta name="keywords" content="HIP, Heterogeneous-computing Interface for Portability, HIP programming guide">
|
|
|
|
|
</head>
|
2024-06-18 17:04:04 -04:00
|
|
|
|
2024-12-15 19:31:35 +01:00
|
|
|
# HIP documentation
|
2023-04-19 05:49:28 +02:00
|
|
|
|
2024-12-15 19:31:35 +01:00
|
|
|
The Heterogeneous-computing Interface for Portability (HIP) is a C++ runtime API
|
|
|
|
|
and kernel language that lets you create portable applications for AMD and
|
|
|
|
|
NVIDIA GPUs from a single source code. For more information, see [What is HIP?](./what_is_hip)
|
2023-04-19 05:49:28 +02:00
|
|
|
|
2025-09-24 18:57:00 +02:00
|
|
|
```{note}
|
|
|
|
|
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).
|
|
|
|
|
```
|
|
|
|
|
|
2024-12-15 19:31:35 +01:00
|
|
|
Installation instructions are available from:
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
* [Installing HIP](./install/install)
|
|
|
|
|
* [Building HIP from source](./install/build)
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-12-15 19:31:35 +01:00
|
|
|
The HIP documentation is organized into the following categories:
|
|
|
|
|
|
|
|
|
|
::::{grid} 1 2 2 2
|
|
|
|
|
:gutter: 3
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-12-15 19:31:35 +01:00
|
|
|
:::{grid-item-card} Programming guide
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
* {doc}`./understand/programming_model`
|
2025-12-11 10:52:34 +01:00
|
|
|
* {doc}`./understand/performance_optimization`
|
2024-05-07 15:52:14 -04:00
|
|
|
* {doc}`./understand/hardware_implementation`
|
2024-12-15 19:31:35 +01:00
|
|
|
* {doc}`./understand/compilers`
|
2024-05-07 15:52:14 -04:00
|
|
|
* {doc}`./how-to/performance_guidelines`
|
|
|
|
|
* [Debugging with HIP](./how-to/debugging)
|
|
|
|
|
* {doc}`./how-to/logging`
|
2024-12-15 19:31:35 +01:00
|
|
|
* {doc}`./how-to/hip_runtime_api`
|
2025-03-19 22:04:47 +01:00
|
|
|
* {doc}`./how-to/hip_cpp_language_extensions`
|
|
|
|
|
* {doc}`./how-to/kernel_language_cpp_support`
|
2025-10-29 07:42:06 +01:00
|
|
|
* {doc}`./how-to/hip_porting_guide`
|
2024-12-15 19:31:35 +01:00
|
|
|
* {doc}`./how-to/hip_rtc`
|
|
|
|
|
* {doc}`./understand/amd_clr`
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
:::
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
:::{grid-item-card} Reference
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-10-21 16:50:09 +02:00
|
|
|
* [HIP runtime API](./reference/hip_runtime_api_reference)
|
|
|
|
|
* [HIP math API](./reference/math_api)
|
2025-06-02 17:10:41 +02:00
|
|
|
* [HIP complex math API](./reference/complex_math_api)
|
2024-12-15 19:31:35 +01:00
|
|
|
* [HIP environment variables](./reference/env_variables)
|
2025-06-02 17:10:41 +02:00
|
|
|
* [HIP error codes](./reference/error_codes)
|
2025-03-19 22:04:47 +01:00
|
|
|
* [CUDA to HIP API Function Comparison](./reference/api_syntax)
|
2024-05-07 15:52:14 -04:00
|
|
|
* [List of deprecated APIs](./reference/deprecated_api_list)
|
2025-06-02 17:10:41 +02:00
|
|
|
* [Low Precision Floating Point Types](./reference/low_fp_types)
|
2024-12-15 19:31:35 +01:00
|
|
|
* {doc}`./reference/hardware_features`
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
:::
|
|
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
:::{grid-item-card} Tutorial
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-10-21 16:50:09 +02:00
|
|
|
* [HIP basic examples](https://github.com/ROCm/rocm-examples/tree/develop/HIP-Basic)
|
2025-03-19 22:04:47 +01:00
|
|
|
* [HIP examples](https://github.com/ROCm/rocm-examples)
|
2024-10-21 16:50:09 +02:00
|
|
|
* [SAXPY tutorial](./tutorial/saxpy)
|
2025-11-20 19:03:22 +01:00
|
|
|
* [GPU programming patterns](./tutorial/programming-patterns)
|
2024-10-21 16:50:09 +02:00
|
|
|
* [Reduction tutorial](./tutorial/reduction)
|
|
|
|
|
* [Cooperative groups tutorial](./tutorial/cooperative_groups_tutorial)
|
2025-10-29 07:42:06 +01:00
|
|
|
* [HIP Graph API tutorial](./tutorial/graph_api)
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
:::
|
|
|
|
|
|
2023-11-01 10:32:23 -06:00
|
|
|
::::
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
Known issues are listed on the [HIP GitHub repository](https://github.com/ROCm/HIP/issues).
|
|
|
|
|
|
|
|
|
|
To contribute features or functions to the HIP project, refer to [Contributing to HIP](https://github.com/ROCm/HIP/blob/develop/CONTRIBUTING.md).
|
2024-05-28 18:42:08 +02:00
|
|
|
To contribute to the documentation, refer to {doc}`Contributing to ROCm docs <rocm:contribute/contributing>` page.
|
2024-03-18 15:48:19 -04:00
|
|
|
|
2024-05-07 15:52:14 -04:00
|
|
|
You can find licensing information on the [Licensing](https://rocm.docs.amd.com/en/latest/about/license.html) page.
|
