Skip to content

DOC: jax.lax.top_k: fix docstring rendering & add example #21788

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

Merged
merged 1 commit into from
Jun 11, 2024
Merged

DOC: jax.lax.top_k: fix docstring rendering & add example #21788

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
20 changes: 16 additions & 4 deletions jax/_src/lax/lax.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1232,12 +1232,24 @@ def top_k(operand: ArrayLike, k: int) -> tuple[Array, Array]:
k: integer specifying the number of top entries.

Returns:
values: array containing the top k values along the last axis.
indices: array containing the indices corresponding to values.
A tuple ``(values, indices)`` where

- ``values`` is an array containing the top k values along the last axis.
- ``indices`` is an array containing the indices corresponding to values.

See also:
- :func:`jax.lax.approx_max_k`
- :func:`jax.lax.approx_min_k`
- :func:`jax.lax.approx_max_k`
- :func:`jax.lax.approx_min_k`

Example:
Find the largest three values, and their indices, within an array:

>>> x = jnp.array([9., 3., 6., 4., 10.])
>>> values, indices = jax.lax.top_k(x, 3)
>>> values
Array([10., 9., 6.], dtype=float32)
>>> indices
Array([4, 0, 2], dtype=int32)
"""
if core.is_constant_dim(k):
k = int(k)
Expand Down