Repository files navigation

HIPIFY is a set of tools that you can use to automatically translate CUDA source code into portableHIP C++.

The published documentation is available atHIPIFY in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in theHIPIFY/docs folder of this GitHub repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, seeContribute to ROCm documentation.

To build our documentation locally, run the following code.

cd docspip3 install -r .sphinx/requirements.txtpython3 -m sphinx -T -E -b html -d _build/doctrees -D language=en. _build/html

To buildCUDA2HIP (CUDA APIs supported by HIP) documentation, run the followinghipify-clangcommand. This builds the same content asSupported CUDA APIs.

hipify-clang --md --doc-format=full --doc-roc=joint# Alternatively, you can use:hipify-clang --md --doc-format=full --doc-roc=separate

To generate this documentation in CSV, use the--csv option instead of--md. Instead of usingthefull format, you can also build instrict orcompact format.

To see all available options, use the--help or--help-hiddenhipify-clang option.