jax.random.bernoulli

Contents

jax.random.bernoulli#

jax.random.bernoulli(key, p=np.float32(0.5), shape=None)[source]#

Sample Bernoulli random values with given shape and mean.

The values are distributed according to the probability mass function:

\[f(k; p) = p^k(1 - p)^{1 - k}\]

where \(k \in \{0, 1\}\) and \(0 \le p \le 1\).

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

  • p (Array | ndarray | bool | number | bool | int | float | complex) – optional, a float or array of floats for the mean of the random variables. Must be broadcast-compatible with shape. Default 0.5.

  • shape (Sequence[int] | NamedShape | None) – optional, a tuple of nonnegative integers representing the result shape. Must be broadcast-compatible with p.shape. The default (None) produces a result shape equal to p.shape.

Returns:

A random array with boolean dtype and shape given by shape if shape is not None, or else p.shape.

Return type:

Array