derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
38 lines
1.7 KiB
Plaintext
38 lines
1.7 KiB
Plaintext
/**
|
|
@brief The hipCUB project main page.
|
|
@author
|
|
@file
|
|
*/
|
|
|
|
/**
|
|
@mainpage hipCUB Documentation
|
|
|
|
@section overview Overview
|
|
|
|
hipCUB is a thin wrapper library on top of rocPRIM or CUB. It enables developers to port project using CUB library to the
|
|
[HIP](https://github.com/ROCm-Developer-Tools/HIP) layer and to run them on AMD hardware. In [ROCm](https://rocm.github.io/)
|
|
environment hipCUB uses rocPRIM library as the backend, however, on CUDA platforms it uses CUB instead.
|
|
|
|
- When using hipCUB you should only include `<hipcub/hipcub.hpp>` header.
|
|
- When rocPRIM is used as backend `HIPCUB_ROCPRIM_API` is defined.
|
|
- When CUB is used as backend `HIPCUB_CUB_API` is defined.
|
|
- Backends are automaticaly selected based on platform detected by HIP layer (`__HIP_PLATFORM_AMD__`, `__HIP_PLATFORM_NVIDIA__`).
|
|
|
|
@section hipcub_rocprim rocPRIM backend
|
|
|
|
hipCUB with rocPRIM backend may not support all function and features CUB has because of the differences
|
|
between ROCm (HIP) platform and CUDA platform.
|
|
|
|
Not-supported features and differences:
|
|
- Functions, classes and macros which are not in the public API or not documented are not supported.
|
|
- Device-wide primitives can't be called from kernels (dynamic parallelism is not supported in HIP on ROCm).
|
|
- Storage management and debug functions:
|
|
- `Debug`, `PtxVersion`, `SmVersion` functions and `CubDebug`, `CubDebugExit`, `_CubLog` macros are not supported.
|
|
- Intrinsics:
|
|
- `ThreadExit`, `ThreadTrap` - not supported.
|
|
- Warp thread masks (when used) are 64-bit unsigned integers.
|
|
- `member_mask` input argument is ignored in `WARP_*` functions.
|
|
- Arguments `first_thread`, `last_thread`, and `member_mask` are ignored in `Shuffle*` functions.
|
|
|
|
*/
|