mindspore.nn.probability.distribution.StudentT

class mindspore.nn.probability.distribution.StudentT(df=None, mean=None, sd=None, seed=None, dtype=mstype.float32, name='StudentT')[源代码]

StudentT分布（StudentT distribution）。 连续随机分布，取值范围为 \((-\inf, \inf)\) ，概率密度函数为

\[f(x, \nu, \mu, \sigma) = (1 + y^2 / \nu)^{(-0.5*(\nu + 1))} / Z\]

其中 \(y = (x - \mu) / \sigma\)、 \(Z = abs(\sigma) * \sqrt{(\nu * \pi)} * \Gamma(0.5 * \nu) / \Gamma(0.5 * (\nu + 1))\) 和 \(\nu, \mu, \sigma\) 为分别为StudentT分布的自由度，期望与标准差。

参数：

  • df (Union[int, float, list, numpy.ndarray, Tensor]，可选) - StudentT分布的自由度。 如果输入为None，那么分布的自由度将在运行时传入。默认值：None。

  • mean (Union[int, float, list, numpy.ndarray, Tensor], 可选) - StudentT分布的平均值。 如果输入为None，那么分布的平均值将在运行时传入。默认值：None。

  • sd (Union[int, float, list, numpy.ndarray, Tensor], 可选) - StudentT分布的标准差。 如果输入为None，那么分布的标准差差将在运行时传入。默认值：None。

  • seed (int, 可选) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。

  • dtype (mindspore.dtype, 可选) - 事件样例的类型。默认值：mstype.float32。

  • name (str, 可选) - 分布的名称。默认值：’StudentT’。

说明

  • df 必须大于0。

  • sd 必须大于0。

  • dtype 必须是float，因为StudentT分布是连续的。

  • 如果在方法函数调用中传入参数 df 、 mean 或者 sd ，则计算中会使用传参值，否则就会使用初始化时的参数值。

异常：

  • ValueError - df 中元素不大于0。

  • ValueError - sd 中元素不大于0。

  • TypeError - dtype 不是float的子类。

支持平台：

CPU

样例：

>>> import mindspore
>>> import mindspore.nn as nn
>>> import mindspore.nn.probability.distribution as msd
>>> from mindspore import Tensor
>>> # To initialize a StudentT distribution of the df 2.0, the mean 3.0 and the standard deviation 4.0.
>>> n1 = msd.StudentT(2.0, 3.0, 4.0, dtype=mindspore.float32)
>>> # A StudentT distribution can be initialized without arguments.
>>> # In this case, `df`, `mean` and `sd` must be passed in through arguments.
>>> n2 = msd.StudentT(dtype=mindspore.float32)
>>> # Here are some tensors used below for testing
>>> value = Tensor([1.0, 2.0, 3.0], dtype=mindspore.float32)
>>> df_a = Tensor([2.0], dtype=mindspore.float32)
>>> mean_a = Tensor([2.0], dtype=mindspore.float32)
>>> sd_a = Tensor([2.0, 2.0, 2.0], dtype=mindspore.float32)
>>> df_b = Tensor([1.0], dtype=mindspore.float32)
>>> mean_b = Tensor([1.0], dtype=mindspore.float32)
>>> sd_b = Tensor([1.0, 1.5, 2.0], dtype=mindspore.float32)
>>> ans = n1.log_prob(value)
>>> print(ans.shape)
(3,)
>>> # Evaluate with respect to the distribution b.
>>> ans = n1.log_prob(value, df_b, mean_b, sd_b)
>>> print(ans.shape)
(3,)
>>> # `mean` and `sd` must be passed in during function calls
>>> ans = n2.log_prob(value, df_a, mean_a, sd_a)
>>> print(ans.shape)
(3,)
log_prob(value, df=None, mean=None, sd=None)

计算StudentT分布给定值对应的概率的对数。

参数：

  • value (Tensor) - 要计算的值。

  • df (Tensor, 可选) - 分布的自由度。默认值：None。

  • mean (Tensor, 可选) - 分布的期望。默认值：None。

  • sd (Tensor, 可选) - 分布的扩散度。默认值：None。

返回：

Tensor，概率密度函数的对数。