jax.random.poisson#

jax.random.poisson(key, lam, shape=None, dtype=<class 'int'>)[source]#

Sample Poisson random values with given shape and integer dtype.

The values are distributed according to the probability mass function:

\[f(k; \lambda) = \frac{\lambda^k e^{-\lambda}}{k!}\]

Where k is a non-negative integer and \(\lambda > 0\).

Parameters:

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

  • lam (RealArray) – rate parameter (mean of the distribution), must be >= 0. Must be broadcast-compatible with shape

  • shape (Shape | None | None) – optional, a tuple of nonnegative integers representing the result shape. Default (None) produces a result shape equal to lam.shape.

  • dtype (DTypeLikeInt) – optional, a integer dtype for the returned values (default int64 if jax_enable_x64 is true, otherwise int32).

Returns:

A random array with the specified dtype and with shape given by shape if shape is not None, or else by ``lam.shape.

Return type:

Array