jax.random.poisson

Warning

This page was created from a pull request (#9655).

jax.random.poissonΒΆ

jax.random.poisson(key, lam, shape=None, dtype=<class 'numpy.int64'>)[source]ΒΆ

Sample Poisson random values with given shape and integer dtype.

Parameters
  • key (Union[Any, PRNGKeyArray]) – a PRNG key used as the random key.

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

  • shape (Optional[Sequence[int]]) – optional, a tuple of nonnegative integers representing the result shape. Default (None) produces a result shape equal to lam.shape.

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

Return type

ndarray

Returns

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