jax.random.categorical¶

jax.random.categorical(key, logits, axis=-1, shape=None)[source]¶

Sample random values from categorical distributions.

Parameters

key – a PRNGKey used as the random key.
logits – Unnormalized log probabilities of the categorical distribution(s) to sample from, so that softmax(logits, axis) gives the corresponding probabilities.
axis – Axis along which logits belong to the same categorical distribution.
shape – Optional, a tuple of nonnegative integers representing the result shape. Must be broadcast-compatible with np.delete(logits.shape, axis). The default (None) produces a result shape equal to np.delete(logits.shape, axis).

Returns

A random array with int dtype and shape given by shape if shape is not None, or else np.delete(logits.shape, axis).