HIP documentation

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?

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.

Installation instructions are available from:

• Installing HIP

• Building HIP from source

The HIP documentation is organized into the following categories:

Programming guide

• Introduction to the HIP programming model

• Hardware implementation

• HIP compilers

• Performance guidelines

• Debugging with HIP

• Logging HIP activity

• Using HIP runtime API

• HIP C++ language extensions

• Kernel language C++ support

• HIP porting guide

• HIP porting: driver API guide

• Programming for HIP runtime compiler (RTC)

• AMD compute language runtimes (CLR)

Reference

• HIP runtime API

• HIP math API

• HIP complex math API

• HIP environment variables

• HIP error codes

• CUDA to HIP API Function Comparison

• List of deprecated APIs

• Low Precision Floating Point Types

• Hardware features

Tutorial

• HIP basic examples

• HIP examples

• SAXPY tutorial

• Reduction tutorial

• Cooperative groups 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 Contributing to ROCm docs page.

You can find licensing information on the Licensing page.