Ctrl+K

jax.random.pareto

Contents

jax.random.pareto#

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

Sample Pareto random values with given shape and float dtype.

The values are distributed according to the probability density function:

\[f(x; b) = b / x^{b + 1}\]

on the domain \(1 \le x < \infty\) with \(b > 0\)

Parameters:

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

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

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

  • 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 with shape given by shape if shape is not None, or else by b.shape.

Return type:

Array

Contents