jax.random.ball

Contents

jax.random.ball#

jax.random.ball(key, d, p=2, shape=(), dtype=None, *, out_sharding=None)[source]#

Sample uniformly from the unit Lp ball.

Reference: https://arxiv.org/abs/math/0503650.

Parameters:

  • key (ArrayLike) – a PRNG key used as the random key.

  • d (int) – a nonnegative int representing the dimensionality of the ball.

  • p (float) – a float representing the p parameter of the Lp norm.

  • shape (Shape) – optional, the batch dimensions of the result. Default ().

  • dtype (DTypeLikeFloat | None) – optional, a float dtype for the returned values (default float64 if jax_enable_x64 is true, otherwise float32).

  • out_sharding (NamedSharding | P | None) – optional, specifies how the output array should be sharded across devices in multi-device computation. Can be a NamedSharding, a PartitionSpec (P), or None (default). When specified, the output will be sharded according to the given sharding specification. Primarily used in explicit sharding mode. See the explicit sharding tutorial for more details.

Returns:

A random array of shape (*shape, d) and specified dtype.

Contents