mindspore.nn.probability.distribution.Exponential
- class mindspore.nn.probability.distribution.Exponential(rate=None, seed=None, dtype=mstype.float32, name='Exponential')[源代码]
指数分布(Exponential Distribution)。 连续随机分布,取值范围为所有正实数 \([0, \inf)\),概率密度函数为
\[f(x, \lambda) = \lambda \exp(-\lambda x)\]其中 \(\lambda\) 为分别为指数分布的率参数。
- 参数:
rate (int, float, list, numpy.ndarray, Tensor) - 率参数。默认值:
None
。seed (int) - 采样时使用的种子。如果为None,则使用全局种子。默认值:None。
dtype (mindspore.dtype) - 事件样例的类型。默认值:mstype.float32。
name (str) - 分布的名称。默认值:
'Exponential'
。
说明
rate 中的元素必须大于0。
dtype 必须是float,因为指数分布是连续的。
- 异常:
ValueError - rate 中元素小于0。
TypeError - dtype 不是float的子类。
- 支持平台:
Ascend
GPU
样例:
>>> import mindspore >>> import mindspore.nn as nn >>> import mindspore.nn.probability.distribution as msd >>> from mindspore import Tensor >>> # To initialize a Exponential distribution of the probability 0.5. >>> e1 = msd.Exponential(0.5, dtype=mindspore.float32) >>> # An Exponential distribution can be initialized without arguments. >>> # In this case, `rate` must be passed in through `args` during function calls. >>> e2 = msd.Exponential(dtype=mindspore.float32) >>> # Here are some tensors used below for testing >>> value = Tensor([1, 2, 3], dtype=mindspore.float32) >>> rate_a = Tensor([0.6], dtype=mindspore.float32) >>> rate_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`, are the same as follows. >>> # Args: >>> # value (Tensor): the value to be evaluated. >>> # rate (Tensor): the rate of the distribution. Default: self.rate. >>> # Examples of `prob`. >>> # Similar calls can be made to other probability functions >>> # by replacing `prob` by the name of the function. >>> ans = e1.prob(value) >>> print(ans.shape) (3,) >>> # Evaluate with respect to distribution b. >>> ans = e1.prob(value, rate_b) >>> print(ans.shape) (3,) >>> # `rate` must be passed in during function calls. >>> ans = e2.prob(value, rate_a) >>> print(ans.shape) (3,) >>> # Functions `mean`, `sd`, 'var', and 'entropy' have the same arguments as follows. >>> # Args: >>> # rate (Tensor): the rate of the distribution. Default: self.rate. >>> # Examples of `mean`. `sd`, `var`, and `entropy` are similar. >>> ans = e1.mean() # return 2 >>> print(ans.shape) () >>> ans = e1.mean(rate_b) # return 1 / rate_b >>> print(ans.shape) (3,) >>> # `rate` must be passed in during function calls. >>> ans = e2.mean(rate_a) >>> print(ans.shape) (1,) >>> # Interfaces of `kl_loss` and `cross_entropy` are the same. >>> # Args: >>> # dist (str): The name of the distribution. Only 'Exponential' is supported. >>> # rate_b (Tensor): the rate of distribution b. >>> # rate_a (Tensor): the rate of distribution a. Default: self.rate. >>> # Examples of `kl_loss`. `cross_entropy` is similar. >>> ans = e1.kl_loss('Exponential', rate_b) >>> print(ans.shape) (3,) >>> ans = e1.kl_loss('Exponential', rate_b, rate_a) >>> print(ans.shape) (3,) >>> # An additional `rate` must be passed in. >>> ans = e2.kl_loss('Exponential', rate_b, rate_a) >>> print(ans.shape) (3,) >>> # Examples of `sample`. >>> # Args: >>> # shape (tuple): the shape of the sample. Default: () >>> # probs1 (Tensor): the rate of the distribution. Default: self.rate. >>> ans = e1.sample() >>> print(ans.shape) () >>> ans = e1.sample((2,3)) >>> print(ans.shape) (2, 3) >>> ans = e1.sample((2,3), rate_b) >>> print(ans.shape) (2, 3, 3) >>> ans = e2.sample((2,3), rate_a) >>> print(ans.shape) (2, 3, 1)
- property rate
返回 rate 。
- 返回:
Tensor,率参数的值。
- cdf(value, rate)
在给定值下计算累积分布函数(Cumulatuve Distribution Function, CDF)。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,累积分布函数的值。
- cross_entropy(dist, rate_b, rate)
计算分布a和b之间的交叉熵。
- 参数:
dist (str) - 分布的类型。
rate_b (Tensor) - 对比分布的率参数。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,交叉熵的值。
- entropy(rate)
计算熵。
- 参数:
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,熵的值。
- kl_loss(dist, rate_b, rate)
计算KL散度,即KL(a||b)。
- 参数:
dist (str) - 分布的类型。
rate_b (Tensor) - 对比分布的率参数。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,KL散度。
- log_cdf(value, rate)
计算给定值对于的累积分布函数的对数。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,累积分布函数的对数。
- log_prob(value, rate)
计算给定值对应的概率的对数。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,累积分布函数的对数。
- log_survival(value, rate)
计算给定值对应的生存函数的对数。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,生存函数的对数。
- mean(rate)
计算期望。
- 参数:
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,概率分布的期望。
- mode(rate)
计算众数。
- 参数:
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,概率分布的众数。
- prob(value, rate)
计算给定值下的概率。对于连续是计算概率密度函数(Probability Density Function)。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,概率值。
- sample(shape, rate)
采样函数。
- 参数:
shape (tuple) - 样本的shape。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,根据概率分布采样的样本。
- sd(rate)
计算标准差。
- 参数:
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,概率分布的标准差。
- survival_function(value, rate)
计算给定值对应的生存函数。
- 参数:
value (Tensor) - 要计算的值。
rate (Tensor) - 分布的率参数。默认值:
None
。
- 返回:
Tensor,生存函数的值。
- var(rate)
计算方差。
- 参数:
rate (Tensor) - 分布的率参数。默认值:None。
- 返回:
Tensor,概率分布的方差。