Add defaults for min_value and max_value to tree_utils.tree_clip. #1234
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vroulet
reviewed
Mar 11, 2025
There was a problem hiding this comment.
Thank you!
As you are on it, can you modify the docs (just copy paste the following in place of Args and Returns sections)
Args:
tree: pytree.
min_value: optional minimal value to clip all tensors to. If ``None``
(default) then result will not be clipped to any minimum value.
max_value: optional maximal value to clip all tensors to. If ``None``
(default) then result will not be clipped to any maximum value.
Returns:
a tree with the same structure as ``tree``.
carlosgmartin
force-pushed
the
tree_clip_defaults
branch
from
173a656 to
8dab908
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This matches the defaults for jax.numpy.clip.