mindspore.nn.probability.distribution.Geometric

class mindspore.nn.probability.distribution.Geometric(probs=None, seed=None, dtype=mstype.int32, name='Geometric')[source]

Geometric Distribution. A Geometric Distribution is a discrete distribution with the range as the non-negative integers, and the probability mass function as \(P(X = i) = p(1-p)^{i-1}, i = 1, 2, ...\). It represents that there are k failures before the first success, namely that there are in total k+1 Bernoulli trials when the first success is achieved.

Parameters

probs (float, list, numpy.ndarray, Tensor) – The probability of success. Default: None.
seed (int) – The seed used in sampling. Global seed is used if it is None. Default: None.
dtype (mindspore.dtype) – The type of the event samples. Default: mstype.int32.
name (str) – The name of the distribution. Default: ‘Geometric’.

Supported Platforms:: Ascend GPU

Note

probs must be a proper probability (0 < p < 1). dist_spec_args is probs.

Raises: ValueError – When p <= 0 or p >= 1.

Examples

>>> import mindspore
>>> import mindspore.nn as nn
>>> import mindspore.nn.probability.distribution as msd
>>> from mindspore import Tensor
>>> # To initialize a Geometric distribution of the probability 0.5.
>>> g1 = msd.Geometric(0.5, dtype=mindspore.int32)
>>> # A Geometric distribution can be initialized without arguments.
>>> # In this case, `probs` must be passed in through arguments during function calls.
>>> g2 = msd.Geometric(dtype=mindspore.int32)
>>>
>>> # Here are some tensors used below for testing
>>> value = Tensor([1, 0, 1], dtype=mindspore.int32)
>>> probs_a = Tensor([0.6], dtype=mindspore.float32)
>>> probs_b = Tensor([0.2, 0.5, 0.4], dtype=mindspore.float32)
>>>
>>> # Private interfaces of probability functions corresponding to public interfaces, including
>>> # `prob`, `log_prob`, `cdf`, `log_cdf`, `survival_function`, and `log_survival`,
>>> # have the same arguments as follows.
>>> # Args:
>>> #     value (Tensor): the value to be evaluated.
>>> #     probs1 (Tensor): the probability of success of a Bernoulli trial. Default: self.probs.
>>> # Examples of `prob`.
>>> # Similar calls can be made to other probability functions
>>> # by replacing `prob` by the name of the function.
>>> ans = g1.prob(value)
>>> print(ans.shape)
(3,)
>>> # Evaluate with respect to distribution b.
>>> ans = g1.prob(value, probs_b)
>>> print(ans.shape)
(3,)
>>> # `probs` must be passed in during function calls.
>>> ans = g2.prob(value, probs_a)
>>> print(ans.shape)
(3,)
>>> # Functions `mean`, `sd`, `var`, and `entropy` have the same arguments.
>>> # Args:
>>> #     probs1 (Tensor): the probability of success of a Bernoulli trial. Default: self.probs.
>>> # Examples of `mean`. `sd`, `var`, and `entropy` are similar.
>>> ans = g1.mean() # return 1.0
>>> print(ans.shape)
()
>>> ans = g1.mean(probs_b)
>>> print(ans.shape)
(3,)
>>> # Probs must be passed in during function calls
>>> ans = g2.mean(probs_a)
>>> print(ans.shape)
(1,)
>>> # Interfaces of 'kl_loss' and 'cross_entropy' are the same.
>>> # Args:
>>> #     dist (str): the name of the distribution. Only 'Geometric' is supported.
>>> #     probs1_b (Tensor): the probability of success of a Bernoulli trial of distribution b.
>>> #     probs1_a (Tensor): the probability of success of a Bernoulli trial of distribution a.
>>> # Examples of `kl_loss`. `cross_entropy` is similar.
>>> ans = g1.kl_loss('Geometric', probs_b)
>>> print(ans.shape)
(3,)
>>> ans = g1.kl_loss('Geometric', probs_b, probs_a)
>>> print(ans.shape)
(3,)
>>> # An additional `probs` must be passed in.
>>> ans = g2.kl_loss('Geometric', probs_b, probs_a)
>>> print(ans.shape)
(3,)
>>> # Examples of `sample`.
>>> # Args:
>>> #     shape (tuple): the shape of the sample. Default: ()
>>> #     probs1 (Tensor): the probability of success of a Bernoulli trial. Default: self.probs.
>>> ans = g1.sample()
>>> print(ans.shape)
()
>>> ans = g1.sample((2,3))
>>> print(ans.shape)
(2, 3)
>>> ans = g1.sample((2,3), probs_b)
>>> print(ans.shape)
(2, 3, 3)
>>> ans = g2.sample((2,3), probs_a)
>>> print(ans.shape)
(2, 3, 1)

property probs

Return the probability of success.

Returns

Tensor, the probability of success.

cdf(value, probs)

Compute the cumulatuve distribution function(CDF) of the given value.

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the cumulatuve distribution function for the given input.

cross_entropy(dist, probs_b, probs)

Compute the cross entropy of two distribution

Parameters

dist (str) - the type of the other distribution.
probs_b (Tensor) - the probability of success of the other distribution.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the cross entropy.

entropy(probs)

Compute the value of the entropy.

Parameters

probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the entropy.

kl_loss(dist, probs_b, probs)

Compute the value of the K-L loss between two distribution, namely KL(a||b).

Parameters

dist (str) - the type of the other distribution.
probs_b (Tensor) - the probability of success of the other distribution.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the K-L loss.

log_cdf(value, probs)

Compute the log value of the cumulatuve distribution function.

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the log value of the cumulatuve distribution function.

log_prob(value, probs)

the log value of the probability.

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the log value of the probability.

log_survival(value, probs)

Compute the log value of the survival function.

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the K-L loss.

mean(probs)

Compute the mean value of the distribution.

Parameters

probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the mean of the distribution.

mode(probs)

Compute the mode value of the distribution.

Parameters

probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the mode of the distribution.

prob(value, probs)

The probability of the given value. For the discrete distribution, it is the probability mass function(pmf).

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the probability.

sample(shape, probs)

Generate samples.

Parameters

shape (tuple) - the shape of the sample.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the sample following the distribution.

sd(probs)

The standard deviation.

Parameters

probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the standard deviation of the distribution.

survival_function(value, probs)

Compute the value of the survival function.

Parameters

value (Tensor) - the value to compute.
probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the value of the survival function.

var(probs)

Compute the variance of the distribution.

Parameters

probs (Tensor) - the probability of success. Default value: None.

Returns

Tensor, the variance of the distribution.