mindspore.nn.probability.distribution.Categorical
- class mindspore.nn.probability.distribution.Categorical(probs=None, seed=None, dtype=mstype.int32, name='Categorical')[源代码]
分类分布。 离散随机分布,取值范围为 \(\{1, 2, ..., k\}\) ,概率质量函数为 \(P(X = i) = p_i, i = 1, ..., k\)。
- 参数:
probs (Tensor, list, numpy.ndarray) - 事件概率。默认值:
None
。seed (int) - 采样时使用的种子。如果为None,则使用全局种子。默认值:
None
。dtype (mindspore.dtype) - 事件样例的类型。默认值:
mstype.int32
。name (str) - 分布的名称。默认值:
Categorical
。
说明
probs 的秩必须至少为1,值是合适的概率,并且总和为1。
- 异常:
ValueError - probs 的秩为0或者其中所有元素的和不等于1。
- 支持平台:
Ascend
GPU
样例:
>>> import mindspore >>> import mindspore.nn as nn >>> import mindspore.nn.probability.distribution as msd >>> from mindspore import Tensor >>> # To initialize a Categorical distribution of probs [0.5, 0.5] >>> ca1 = msd.Categorical(probs=[0.2, 0.8], dtype=mindspore.int32) >>> # A Categorical distribution can be initialized without arguments. >>> # In this case, `probs` must be passed in through arguments during function calls. >>> ca2 = msd.Categorical(dtype=mindspore.int32) >>> # Here are some tensors used below for testing >>> value = Tensor([1, 0], dtype=mindspore.int32) >>> probs_a = Tensor([0.5, 0.5], dtype=mindspore.float32) >>> probs_b = Tensor([0.35, 0.65], 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. >>> # probs (Tensor): event probabilities. 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 = ca1.prob(value) >>> print(ans.shape) (2,) >>> # Evaluate `prob` with respect to distribution b. >>> ans = ca1.prob(value, probs_b) >>> print(ans.shape) (2,) >>> # `probs` must be passed in during function calls. >>> ans = ca2.prob(value, probs_a) >>> print(ans.shape) (2,) >>> # Functions `mean`, `sd`, `var`, and `entropy` have the same arguments. >>> # Args: >>> # probs (Tensor): event probabilities. Default: self.probs. >>> # Examples of `mean`. `sd`, `var`, and `entropy` are similar. >>> ans = ca1.mean() # return 0.8 >>> print(ans.shape) (1,) >>> ans = ca1.mean(probs_b) >>> print(ans.shape) (1,) >>> # `probs` must be passed in during function calls. >>> ans = ca2.mean(probs_a) >>> print(ans.shape) (1,) >>> # Interfaces of `kl_loss` and `cross_entropy` are the same as follows: >>> # Args: >>> # dist (str): the name of the distribution. Only 'Categorical' is supported. >>> # probs_b (Tensor): event probabilities of distribution b. >>> # probs (Tensor): event probabilities of distribution a. Default: self.probs. >>> # Examples of `kl_loss`, `cross_entropy` is similar. >>> ans = ca1.kl_loss('Categorical', probs_b) >>> print(ans.shape) () >>> ans = ca1.kl_loss('Categorical', probs_b, probs_a) >>> print(ans.shape) () >>> # An additional `probs` must be passed in. >>> ans = ca2.kl_loss('Categorical', probs_b, probs_a) >>> print(ans.shape) ()
- property probs
返回事件发生的概率。
- 返回:
Tensor,事件发生的概率。
- cdf(value, probs)
在给定值下计算累积分布函数(Cumulatuve Distribution Function, CDF)。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,累积分布函数的值。
- cross_entropy(dist, probs_b, probs)
计算分布a和b之间的交叉熵。
- 参数:
dist (str) - 分布的类型。
probs_b (Tensor) - 对比分布的事件发生的概率。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,交叉熵的值。
- entropy(probs)
计算熵。
- 参数:
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,熵的值。
- kl_loss(dist, probs_b, probs)
计算KL散度,即KL(a||b)。
- 参数:
dist (str) - 分布的类型。
probs_b (Tensor) - 对比分布的事件发生的概率。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,KL散度。
- log_cdf(value, probs)
计算给定值对于的累积分布函数的对数。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,累积分布函数的对数。
- log_prob(value, probs)
计算给定值对应的概率的对数。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,累积分布函数的对数。
- log_survival(value, probs)
计算给定值对应的生存函数的对数。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,生存函数的对数。
- mean(probs)
计算期望。
- 参数:
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,概率分布的期望。
- mode(probs)
计算众数。
- 参数:
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,概率分布的众数。
- prob(value, probs)
计算给定值下的概率。对于离散分布是计算概率质量函数(Probability Mass Function)。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,概率值。
- sample(shape, probs)
采样函数。
- 参数:
shape (tuple) - 样本的shape。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,根据概率分布采样的样本。
- sd(probs)
计算标准差。
- 参数:
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,概率分布的标准差。
- survival_function(value, probs)
计算给定值对应的生存函数。
- 参数:
value (Tensor) - 要计算的值。
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,生存函数的值。
- var(probs)
计算方差。
- 参数:
probs (Tensor) - 事件发生的概率。默认值:
None
。
- 返回:
Tensor,概率分布的方差。