SWDEV-440545 - [hiprtc] hiprtcLinkAddData with HIPRTC_JIT_INPUT_LLVM_BITCODE takes human-readable LLVM IR too but this is not documented

Fix HIPRTC documentation

Use HIPRTC consistently in documentation.

Fix doxygen comments about HIPRTC_JIT_INPUT_LLVM_BITCODE

Fixes: SWDEV-440545
Change-Id: I0a1a90ea88f1adf0653fffeed88e3971fc913dbb
This commit is contained in:
Yaxun (Sam) Liu
2024-02-05 10:25:24 -05:00
committed by Yaxun Liu
vanhempi dc8e9b11c8
commit 54760221b3
3 muutettua tiedostoa jossa 21 lisäystä ja 21 poistoa
+4 -4
Näytä tiedosto
@@ -123,12 +123,12 @@ AMD_DIRECT_DISPATCH=0
Note, Direct Dispatch is implemented on Linux. It is currently not supported on Windows.
## HIP Runtime Compilation
HIP now supports runtime compilation (hipRTC), the usage of which will provide the possibility of optimizations and performance improvement compared with other APIs via regular offline static compilation.
HIP now supports runtime compilation (HIPRTC), the usage of which will provide the possibility of optimizations and performance improvement compared with other APIs via regular offline static compilation.
hipRTC APIs accept HIP source files in character string format as input parameters and create handles of programs by compiling the HIP source files without spawning separate processes.
HIPRTC APIs accept HIP source files in character string format as input parameters and create handles of programs by compiling the HIP source files without spawning separate processes.
For more details on hipRTC APIs, refer to HIP-API.pdf in GitHub (https://docs.amd.com/category/api_documentation).
For Linux developers, the link here(https://github.com/ROCm-Developer-Tools/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail hipRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/develop/docs/user_guide/hip_rtc.md).
For more details on HIPRTC APIs, refer to HIP-API.pdf in GitHub (https://docs.amd.com/category/api_documentation).
For Linux developers, the link here(https://github.com/ROCm-Developer-Tools/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail HIPRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/develop/docs/user_guide/hip_rtc.md).
## HIP Graph
HIP graph is supported. For more details, refer to the HIP API Guide.