Skip to content

Commit

Permalink
Merge pull request #1839 from randyh62/table-update
Browse files Browse the repository at this point in the history
[HIPIFY][doc][fix] Update Table URLs and other minor changes
  • Loading branch information
emankov authored Jan 22, 2025
2 parents 459b101 + 62a91ca commit c4746c7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ HIPIFY is a ROCm tool to help developers migrate GPU programming from NVIDIA's C

`hipify_torch <https://github.com/ROCm/hipify_torch>`_ is a related tool that also translates CUDA source code into portable HIP C++. It was developed as part of the PyTorch project to cater to the project's unique requirements, was found to be useful for PyTorch-related projects, and released as an independent utility.

HIPIFY does not automatically convert all CUDA code into HIP code seamlessly. While it is a powerful tool for translating CUDA code to HIP, there are some limitations and areas where manual intervention is often required. HIPIFY can automatically convert many CUDA runtime API calls, kernel launch syntax, standard CUDA library functions where there is a HIP library equivalent, specific keywords like __global__ and __device__. However, HIP is not a complete replacement for CUDA, and HIPIFY cannot automatically translate all code. CUDA libraries, or third-party libraries that have no HIP equivalent cannot be translated. In addition, code which is optimized for performance on NVIDIA GPUs might require additional rework to optimize performance on AMD GPUs.
HIPIFY does not automatically convert all CUDA code into HIP code seamlessly. While it is a powerful tool for translating CUDA code to HIP, there are some limitations and areas where manual intervention is often required. HIPIFY can automatically convert many CUDA runtime API calls, kernel launch syntax, standard CUDA library functions where there is a HIP library equivalent, specific keywords like ``__global__`` and ``__device__``. However, HIP is not a complete replacement for CUDA, and HIPIFY cannot automatically translate all code. CUDA libraries, or third-party libraries that have no HIP equivalent cannot be translated. In addition, code which is optimized for performance on NVIDIA GPUs might require additional rework to optimize performance on AMD GPUs.

After migrating code through HIPIFY, you should perform a code review to ensure functional correctness, replace any unsupported libraries or constructs with HIP or ROCm features. Debug and test the new HIP program, and optimize the performance on the target AMD GPUs.

Expand Down
26 changes: 14 additions & 12 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,31 @@ subtrees:
- file: reference/supported_apis
subtrees:
- entries:
- file: tables/CUDA_Runtime_API_functions_supported_by_HIP
- file: reference/tables/CUDA_Runtime_API_functions_supported_by_HIP
title: CUDA Runtime functions
- file: tables/CUDA_Driver_API_functions_supported_by_HIP
- file: reference/tables/CUDA_Driver_API_functions_supported_by_HIP
title: CUDA Driver functions
- file: tables/cuComplex_API_supported_by_HIP
- file: reference/tables/cuComplex_API_supported_by_HIP
title: cuComplex API
- file: tables/CUDA_Device_API_supported_by_HIP
- file: reference/tables/CUDA_Device_API_supported_by_HIP
title: CUDA Device API
- file: tables/CUDA_RTC_API_supported_by_HIP
- file: reference/tables/CUDA_RTC_API_supported_by_HIP
title: CUDA RTC API
- file: tables/CUBLAS_API_supported_by_HIP
- file: reference/tables/CUBLAS_API_supported_by_HIP
title: cuBLAS API
- file: tables/CUSPARSE_API_supported_by_HIP
- file: reference/tables/CUSPARSE_API_supported_by_HIP
title: cuSPARSE
- file: tables/CUSOLVER_API_supported_by_HIP
- file: reference/tables/CUSOLVER_API_supported_by_HIP
title: cuSOLVER API
- file: tables/CURAND_API_supported_by_HIP
- file: reference/tables/CURAND_API_supported_by_HIP
title: cuRAND API
- file: tables/CUFFT_API_supported_by_HIP
- file: reference/tables/CUFFT_API_supported_by_HIP
title: cuFFT API
- file: tables/CUDNN_API_supported_by_HIP
- file: reference/tables/CUDNN_API_supported_by_HIP
title: cuDNN API
- file: tables/CUB_API_supported_by_HIP
- file: reference/tables/CUTENSOR_API_supported_by_HIP
title: cuTENSOR API
- file: reference/tables/CUB_API_supported_by_HIP
title: CUB API
- caption: About
entries:
Expand Down

0 comments on commit c4746c7

Please sign in to comment.