Kiss, Istvan
ed5a6441a9
* Update docs 2025 03 31
- Docs: remove virtual_rocr.rst
- Fix documentation warnings
- Reformat HIP RTC
- Docs: Refactor HIP porting guide
- Docs: Expand HIP porting guide and CUDA driver porting guide
- Minor fix
- Docs: Update environment variables file
- Bump rocm-docs-core[api_reference] from 1.15.0 to 1.17.0 in /docs/sphinx
- Docs: Update FP8 page to show both FP8 and FP16 types
- Bump sphinxcontrib-doxylink from 1.12.4 to 1.13.0 in /docs/sphinx
- Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.17.0 to 1.17.1.
- Remove external link
- Update programming model
- Bump rocm-docs-core[api_reference] from 1.17.1 to 1.18.1 in /docs/sphinx
- Docs: Add page for Complex Math API
- Docs: Add page about HIP error codes
- Update docs: the compilation cache is enabled by default
- Fix fns32 function mask type in doc
* Bump rocm-docs-core[api_reference] from 1.18.1 to 1.18.2 in /docs/sphinx
Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.18.1 to 1.18.2.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.18.1...v1.18.2)
---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
dependency-version: 1.18.2
dependency-type: direct:production
update-type: version-update:semver-patch
* Fix readme link
* Docs: Fix verbose paths generated by doxygen
* Handle git ssh in docs conf.py
[ROCm/hip commit: d0cf32a63a]
2.6 KiB
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?
Installation instructions are available from:
The HIP documentation is organized into the following categories:
::::{grid} 1 2 2 2 :gutter: 3
:::{grid-item-card} Programming guide
- {doc}
./understand/programming_model - {doc}
./understand/hardware_implementation - {doc}
./understand/compilers - {doc}
./how-to/performance_guidelines - Debugging with HIP
- {doc}
./how-to/logging - {doc}
./how-to/hip_runtime_api - {doc}
./how-to/hip_cpp_language_extensions - {doc}
./how-to/kernel_language_cpp_support - HIP porting guide
- HIP porting: driver API guide
- {doc}
./how-to/hip_rtc - {doc}
./understand/amd_clr
:::
:::{grid-item-card} 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
- {doc}
./reference/hardware_features
:::
:::{grid-item-card} 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 {doc}Contributing to ROCm docs <rocm:contribute/contributing> page.
You can find licensing information on the Licensing page.