tfp.math.random_rayleigh

View source on GitHub

Generates Tensor of positive reals drawn from a Rayleigh distributions.

tfp.math.random_rayleigh(
    shape,
    scale=None,
    dtype=tf.float32,
    seed=None,
    name=None
)

The probability density function of a Rayleigh distribution with scale parameter is given by:

f(x) = x scale**-2 exp(-x**2 0.5 scale**-2)

For more details, see Rayleigh distribution

Args:

  • shape: Vector-shaped, int Tensor representing shape of output.
  • scale: (Optional) Positive float Tensor representing Rayleigh scale. Default value: None (i.e., scale = 1.).
  • dtype: (Optional) TF dtype representing dtype of output. Default value: tf.float32.
  • seed: (Optional) Python integer to seed the random number generator. Default value: None (i.e., no seed).
  • name: Python str name prefixed to Ops created by this function. Default value: None (i.e., 'random_rayleigh').

Returns:

  • rayleigh: Tensor with specified shape and dtype consisting of positive real values drawn from a Rayleigh distribution with specified scale.