documentation.md

layout	title
default	ROCm Documentation

ROCm Documentation

The ROCm documentation site is where we assemble quick-start guides, installation guides, programming guides, API reference documentation, tool documentation and whitepapers.

ROCm Install

• ROCm Install Quick Start Guide
• ROCm Install FAQ
• ROCm Supported Hardware
• Quick Start OpenCL
• ROCm Language Introduction

ROCm and AMDGPU Catalyst Driver Comparison

ROCr Run-Time Documentation

• HSA Runtime specification---HSA Foundation online documents
• ROCr error codes

AMDGPU LLVM Compiler

• Doucmentation for AMDGPU Code Generator in LVVM

HCC

• HCC overview
• How to use HCC and select a GPU device
• HCC language API documentation
• HC API: Moving Beyond C++ AMP for Accelerated GPU Computing
• HCC Saxpy example

HIP

• HIP porting guide: overview and how-to
• HIP terminology comparison with OpenCL, Cuda, C++ AMP and HCC
• HIP run-time API overview and documentation (Doxygen)
• HIP kernel-language overview
• HIP FAQ

GCN ISA, ROCm Object Format, ABI and Assembly Documentation

• GCN Architecture overview
• GCN Architecure crash course by Lala Mah
• GFX7 GCN ISA Southern Islands manual---Hawaii
• GFX8 GCN Version 3---Tonga, Fiji and Polaris
• AMD GPU-compute application binary interface (ABI)
• Documentation covering helper tools for ROCm GCN LLVM assembler
• GCN float16
• ROC device library---Open Compute Math Library intrinsics

Development Tools

• ROCm profiler: overview and how-to
• GPU Performance API (GPUPerfAPI), including access to performance counters
• ROCm GDB debugger: overview and how-to
• ROCm compiler development: foundation for creating your own compiler

MIOpen

• MIOpen Documentation
• MIOpen GEMM - Deep Learning Optimized Gemm Library

DevOps and System Management

• ROCm system-management interface (SMI) documentation
• ROCm Docker: setup and how-to
• ROCm use of PCIe Atomics and PCIe BAR overivew