Skip to content

[doc] jnp.take: better description of unique_indices & indices_are_sorted #33507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

[doc] jnp.take: better description of unique_indices & indices_are_sorted #33507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions jax/_src/numpy/indexing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,14 @@ def take(
fill_value: The fill value to return for out-of-bounds slices when mode is 'fill'.
Ignored otherwise. Defaults to NaN for inexact types, the largest negative value for
signed types, the largest positive value for unsigned types, and True for booleans.
unique_indices: If True, the implementation will assume that the indices are unique,
which can result in more efficient execution on some backends. If set to True and
indices are not unique, the output is undefined.
unique_indices: If True, the implementation will assume that the indices are unique
after normalization of negative indices, which lets the compiler emit more efficient
code during the backward pass. If set to True and normalized indices are not unique,
the result is implementation-defined and may be non-deterministic.
indices_are_sorted : If True, the implementation will assume that the indices are
sorted in ascending order, which can lead to more efficient execution on some
backends. If set to True and indices are not sorted, the output is undefined.
sorted in ascending order after normalization of negative indices, which can lead
to more efficient execution on some backends. If set to True and normalized indices
are not sorted, the output is implementation-defined.

Returns:
Array of values extracted from ``a``.
Expand Down
Loading