Skip to content

Add tip to tree reduce and reduce_associative about how to exclude leaves from the reduction. #30172

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
Aug 8, 2025
Merged

Add tip to tree reduce and reduce_associative about how to exclude leaves from the reduction. #30172

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
10 changes: 10 additions & 0 deletions jax/_src/tree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ def reduce(function: Callable[[T, Any], T],
>>> jax.tree.reduce(operator.add, [1, (2, 3), [4, 5, 6]])
21

Notes:
**Tip**: You can exclude leaves from the reduction by first mapping them to
``None`` using :func:`jax.tree.map`. This causes them to not be counted as
leaves after that.

See Also:
- :func:`jax.tree.reduce_associative`
- :func:`jax.tree.leaves`
Expand Down Expand Up @@ -230,6 +235,11 @@ def reduce_associative(
>>> jax.tree.reduce_associative(operator.add, [1, (2, 3), [4, 5, 6]])
21

Notes:
**Tip**: You can exclude leaves from the reduction by first mapping them to
``None`` using :func:`jax.tree.map`. This causes them to not be counted as
leaves after that.

See Also:
- :func:`jax.tree.reduce`
"""
Expand Down
Loading