random.split: add optional shape parameter #16398
Closed
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.
Fixes #4013. Why now? This will aid in the transition to custom PRNG ( #9263) because it allows split keys to be reshaped without having to account for the intrinsic key dimension.
Suppose you'd like to create six keys, reshaped into batch dimensions of shape
(2, 3)
.Before custom PRNG, you could write something like this, assuming you're using the default PRNG impl:
With custom PRNG, it must change to this:
To write this operation in a way that is compatible with both requires something like this, which is somewhat ugly/unclear:
With this PR, we can instead write this and be compatible with both cases:
Regarding the API chosen here: I considered overloading the
num
parameter to also accept a tuple of integers, but I judged it cleaner to avoid that kind of polymorphism. I madeshape
a keyword-only argument for clarity.