rocm-systems/docs/index.md

HIP documentation

HIP is a C++ runtime API and kernel language that lets developers create portable applications for AMD and NVIDIA GPUs from single source code.

Overview

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

:::{grid-item-card} Install

• Installing HIP
• Building HIP from source

:::

:::{grid-item-card} Conceptual

• {doc}./understand/programming_model
• {doc}./understand/programming_model_reference
• {doc}./understand/hardware_implementation

:::

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

• Programming Manual
• HIP Porting Guide
• HIP Porting: Driver API Guide
• {doc}./how-to/hip_rtc
• {doc}./how-to/performance_guidelines
• Debugging with HIP
• {doc}./how-to/logging
• {doc}./how-to/faq

:::

:::{grid-item-card} Reference

• {doc}/doxygen/html/index
• C++ language extensions
• Comparing Syntax for different APIs
• HSA Runtime API for ROCm
• List of deprecated APIs

:::

:::{grid-item-card} Tutorial

• HIP examples
• HIP test samples

:::

::::

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.