jax.random.beta

Contents

jax.random.beta#

jax.random.beta(key, a, b, shape=None, dtype=<class 'float'>)[source]#

Sample Beta random values with given shape and float dtype.

The values are distributed according to the probability density function:

\[f(x;a,b) \propto x^{a - 1}(1 - x)^{b - 1}\]

on the domain \(0 \le x \le 1\).

Parameters:
  • key (Array | ndarray | bool_ | number | bool | int | float | complex) – a PRNG key used as the random key.

  • a (Array | ndarray | bool_ | number | bool | int | float | complex) – a float or array of floats broadcast-compatible with shape representing the first parameter “alpha”.

  • b (Array | ndarray | bool_ | number | bool | int | float | complex) – a float or array of floats broadcast-compatible with shape representing the second parameter “beta”.

  • shape (Sequence[int] | None) – optional, a tuple of nonnegative integers specifying the result shape. Must be broadcast-compatible with a and b. The default (None) produces a result shape by broadcasting a and b.

  • dtype (str | type[Any] | dtype | SupportsDType) – optional, a float dtype for the returned values (default float64 if jax_enable_x64 is true, otherwise float32).

Returns:

A random array with the specified dtype and shape given by shape if shape is not None, or else by broadcasting a and b.

Return type:

Array