Skip to content

Commit

Permalink
add supported data type page to docs (#500)
Browse files Browse the repository at this point in the history
* add supported data type page to docs

* add clarification to the data support page

* fix review comments
make table clearer
add data support page to _toc.yml

* changed orange square to attention sign
fixed explainer under the data support table
  • Loading branch information
parbenc authored Jan 18, 2024
1 parent 7e189b1 commit e55fbf5
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/data-type-support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. meta::
:description: rocPRIM API library data type support
:keywords: rocPRIM, ROCm, API library, API reference, data type, support

.. _data-type-support:

******************************************
Data type support
******************************************

* Supported input and output types.

.. list-table:: Supported Input/Output Types
:header-rows: 1
:name: supported-input-output-types

*
- Input/Output Types
- Library Data Type
- Support
*
- int8
- int8_t
- ⚠️
*
- float8
- Not Supported
- ❌
*
- bfloat8
- Not Supported
- ❌
*
- int16
- int16_t
- ❌
*
- float16
- rocprim::half
- ⚠️
*
- bfloat16
- rocprim::bfloat16
- ⚠️
*
- int32
- int
- ✅
*
- tensorfloat32
- Not Supported
- ❌
*
- float32
- float
- ✅
*
- float64
- double
- ✅

* The ⚠️ means that the data type is mostly supported, but there are some API tests, that do not work.
* The ``block_histogram`` test fails with ``int8``.
* The ``device_histogram`` and ``device_reduce_by_key`` doesn't work with ``rocprim::half`` and ``rocprim::bfloat16``.
* The ``device_run_length_encode``, ``warp_exchange`` and ``warp_load`` doesn't work with ``rocprim::half``.
1 change: 1 addition & 0 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ subtrees:
- entries:
- file: intro
- file: ops_summary
- file: data-type-support
- file: device_ops/index
- file: block_ops/index
- file: warp_ops/index
Expand Down

0 comments on commit e55fbf5

Please sign in to comment.