rocm-systems/projects/hip/docs/index.md

HIP documentation

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

:::{grid-item-card} Installation

• Install HIP
• Build HIP from source

:::

:::{grid-item-card} Reference

• {doc}/reference/programming_model
• {doc}/doxygen/html/index
• Deprecated APIs

:::

:::{grid-item-card} How-to

• Debug with HIP
• Generate logs

:::

:::{grid-item-card} Conceptual

• {doc}/understand/programming_model

:::

::::

Legacy documentation

These documents have not yet been ported over to the Diátaxis framework.

::::{grid} 1 1 2 2 :gutter: 1

:::{grid-item-card} Reference

• C++ kernel language
• Table Comparing Syntax for Different Compute APIs

:::

:::{grid-item-card} User Guide

• HIP Porting Guide
• HIP Porting Driver API Guide

:::

::::

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 GitHub.

If you want to contribute to the HIP project, refer to our Contributor guidelines.