[Doc] Split radix_sort doc page into key and key-value API #1586
Conversation
dmitriy-sobolev
changed the title
dmitriy-sobolev
force-pushed
the
dev/dmitriy-sobolev/doc-esimd-split
branch
from
c64c223 to
e1b48f0
Compare
Signed-off-by: Dmitriy Sobolev <[email protected]>
Signed-off-by: Dmitriy Sobolev <[email protected]>
dmitriy-sobolev
requested review from
danhoeflinger
and removed request for
danhoeflinger
documentation/library_guide/kernel_templates/esimd/radix_sort_by_key.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Dmitriy Sobolev <[email protected]>
documentation/library_guide/kernel_templates/esimd/radix_sort.rst
Outdated
Show resolved
Hide resolved
documentation/library_guide/kernel_templates/esimd/radix_sort.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Dmitriy Sobolev <[email protected]>
Signed-off-by: Dmitriy Sobolev <[email protected]>
Signed-off-by: Dmitriy Sobolev <[email protected]>
documentation/library_guide/kernel_templates/esimd/radix_sort.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Dmitriy Sobolev <[email protected]>
documentation/library_guide/kernel_templates/esimd/radix_sort.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Dmitriy Sobolev <[email protected]>
|
@dcbenito, could you assist with verifying the changes? |
|
|
||
| where N\ :sub:`keys_per_workgroup` and N\ :sub:`values_per_workgroup` are the amounts of memory | ||
| to store keys and values, respectively. `C` is some additional space for storing internal data. | ||
| where N\ :sub:`keys_per_workgroup` is the amounts of memory to store keys. |
There was a problem hiding this comment.
Please change amounts to amount.
| - The element type of sequence(s) to sort must be a C++ integral or floating-point type | ||
| other than ``bool`` with a width of up to 64 bits. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
This formatting is odd and not rendering in Note form. Should this be a note or a header?
There was a problem hiding this comment.
If I got you correctly, the comment is about rendering of the note if you open the file on GitHub in "preview" format.
If so, there are other instances of the same issue in other places, for example, https://github.com/oneapi-src/oneDPL/blob/main/documentation/library_guide/parallel_api/range_based_api.rst, so I guess it is a common issue.
The note is rendered properly if this document is interpreted into html format by Sphinx tool.
There was a problem hiding this comment.
I think that the Current Limitations sub-header was confusing me. I built the docs and can see that it does render correctly, so this is a non-issue that you can ignore.
| N\ :sub:`keys_per_workgroup` + N\ :sub:`values_per_workgroup` + C | ||
|
|
||
| where N\ :sub:`keys_per_workgroup` and N\ :sub:`values_per_workgroup` are the amounts of memory | ||
| to store keys and values, respectively. `C` is some additional space for storing internal data. |
There was a problem hiding this comment.
Please remove the double space between "...respectively. 'C' is some..."
There was a problem hiding this comment.
Thanks, fixed.
Signed-off-by: Dmitriy Sobolev <[email protected]>
dmitriy-sobolev
dismissed stale reviews from dcbenito and danhoeflinger
via
f16b5d9
Separate
radix_sortandradix_sort_by_key.Pros:
Cons:
I assume that benefits outweigh drawbacks specifically from a user perspective.
This PR was motivated by this discussion: #1583 (comment)