jax.random.t

Contents

jax.random.t#

jax.random.t(key, df, shape=(), dtype=<class 'float'>)[source]#

Sample Student’s t random values with given shape and float dtype.

The values are distributed according to the probability density function:

\[f(t; \nu) \propto \left(1 + \frac{t^2}{\nu}\right)^{-(\nu + 1)/2}\]

Where \(\nu > 0\) is the degrees of freedom, given by the parameter df.

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

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

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

Return type:

Array