2024-03-18 15:48:19 -04:00
|
|
|
|
# HIP documentation
|
2023-04-19 05:49:28 +02:00
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
|
|
::::{grid} 1 1 2 2
|
|
|
|
|
|
:gutter: 1
|
|
|
|
|
|
|
2024-03-18 15:48:19 -04:00
|
|
|
|
:::{grid-item-card} Installation
|
|
|
|
|
|
|
|
|
|
|
|
* [Install HIP](./install/install)
|
|
|
|
|
|
* [Build HIP from source](./install/build)
|
|
|
|
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
|
|
:::{grid-item-card} Reference
|
|
|
|
|
|
|
|
|
|
|
|
* {doc}`/reference/programming_model`
|
|
|
|
|
|
* {doc}`/doxygen/html/index`
|
|
|
|
|
|
* [Deprecated APIs](./reference/deprecated_api_list)
|
|
|
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
|
:::
|
|
|
|
|
|
|
2024-03-18 15:48:19 -04:00
|
|
|
|
:::{grid-item-card} How-to
|
|
|
|
|
|
|
|
|
|
|
|
* [Debug with HIP](./how-to/debugging)
|
|
|
|
|
|
* [Generate logs](./how-to/logging)
|
|
|
|
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
|
|
:::{grid-item-card} Conceptual
|
|
|
|
|
|
|
|
|
|
|
|
* {doc}`/understand/programming_model`
|
|
|
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
|
:::
|
|
|
|
|
|
|
2024-03-18 15:48:19 -04:00
|
|
|
|
::::
|
|
|
|
|
|
|
|
|
|
|
|
## Legacy documentation
|
|
|
|
|
|
|
|
|
|
|
|
These documents have not yet been ported over to the Diátaxis framework.
|
|
|
|
|
|
|
|
|
|
|
|
::::{grid} 1 1 2 2
|
|
|
|
|
|
:gutter: 1
|
|
|
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
|
:::{grid-item-card} Reference
|
2024-03-18 15:48:19 -04:00
|
|
|
|
|
|
|
|
|
|
* [C++ kernel language](./old/reference/kernel_language)
|
|
|
|
|
|
* [Table Comparing Syntax for Different Compute APIs](./old/reference/terms)
|
|
|
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
|
:::
|
|
|
|
|
|
|
2024-03-18 15:48:19 -04:00
|
|
|
|
:::{grid-item-card} User Guide
|
|
|
|
|
|
|
|
|
|
|
|
* [HIP Porting Guide](./old/user_guide/hip_porting_guide)
|
|
|
|
|
|
* [HIP Porting Driver API Guide](./old/user_guide/hip_porting_driver_api)
|
|
|
|
|
|
|
2023-04-19 05:49:28 +02:00
|
|
|
|
:::
|
|
|
|
|
|
|
2023-11-01 10:32:23 -06:00
|
|
|
|
::::
|
2024-03-18 15:48:19 -04:00
|
|
|
|
|
|
|
|
|
|
We welcome collaboration! If you’d like to contribute to our documentation, you can find instructions
|
|
|
|
|
|
on our {doc}`Contribute to ROCm docs <rocm:contribute/contributing>` page. Known issues are listed on
|
2024-04-03 15:10:36 -04:00
|
|
|
|
[GitHub](https://github.com/ROCm/HIP/issues).
|
2024-03-18 15:48:19 -04:00
|
|
|
|
|
2024-04-03 15:10:36 -04:00
|
|
|
|
If you want to contribute to the HIP project, refer to our [Contributor guidelines](https://github.com/ROCm/HIP/CONTRIBUTING.md).
|
