Pareto

class tensorplay.distributions.Pareto(scale: Tensor | float, alpha: Tensor | float, validate_args: bool | None = None)[source]

Samples from a Pareto Type 1 distribution.

Example:

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> m = Pareto(tensorplay.tensor([1.0]), tensorplay.tensor([1.0]))
>>> m.sample()  # sample from a Pareto distribution with scale=1 and alpha=1
tensor([ 1.5623])

Parameters:

• scale (float or Tensor) – Scale parameter of the distribution

• alpha (float or Tensor) – Shape parameter of the distribution

property batch_shape: Size

Returns the shape over which parameters are batched.

cdf(value)

Computes the cumulative distribution function by inverting the transform(s) and computing the score of the base distribution.

enumerate_support(expand: bool = True) → Tensor

Returns tensor containing all values supported by a discrete distribution. The result will enumerate over dimension 0, so the shape of the result will be (cardinality,) + batch_shape + event_shape (where event_shape = () for univariate distributions).

Note that this enumerates over all batched tensors in lock-step [[0, 0], [1, 1], …]. With expand=False, enumeration happens along dim 0, but with the remaining batch dimensions being singleton dimensions, [[0], [1], ...

To iterate over the full Cartesian product use itertools.product(m.enumerate_support()).

Parameters:

expand (bool) – whether to expand the support over the batch dims to match the distribution’s batch_shape.

Returns:

Tensor iterating over dimension 0.

property event_shape: Size

Returns the shape of a single sample (without batching).

icdf(value)

Computes the inverse cumulative distribution function using transform(s) and computing the score of the base distribution.

log_prob(value)

Scores the sample by inverting the transform(s) and computing the score using the score of the base distribution and the log abs det jacobian.

perplexity() → Tensor

Returns perplexity of distribution, batched over batch_shape.

Returns:

Tensor of shape batch_shape.

rsample(sample_shape: Size | Sequence[int] = ()) → Tensor

Generates a sample_shape shaped reparameterized sample or sample_shape shaped batch of reparameterized samples if the distribution parameters are batched. Samples first from base distribution and applies transform() for every transform in the list.

sample(sample_shape=())

Generates a sample_shape shaped sample or sample_shape shaped batch of samples if the distribution parameters are batched. Samples first from base distribution and applies transform() for every transform in the list.

sample_n(n: int) → Tensor

Generates n samples or n batches of samples if the distribution parameters are batched.

static set_default_validate_args(value: bool) → None

Sets whether validation is enabled or disabled.

The default behavior mimics Python’s assert statement: validation is on by default, but is disabled if Python is run in optimized mode (via python -O). Validation may be expensive, so you may want to disable it once a model is working.

Parameters:

value (bool) – Whether to enable validation.

property stddev: Tensor

Returns the standard deviation of the distribution.