mindspore.nn.probability.distribution.StudentT
================================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/r2.3.q1/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindspore/blob/r2.3.q1/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.StudentT.rst
    :alt: 查看源文件


.. py:class:: mindspore.nn.probability.distribution.StudentT(df=None, mean=None, sd=None, seed=None, dtype=mstype.float32, name='StudentT')

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

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


    其中 :math:`y = (x - \mu)/ \sigma`、  :math:`Z = abs(\sigma) * \sqrt{(\nu * \pi)} * \Gamma(0.5 * \nu) / \Gamma(0.5 * (\nu + 1))` 和 :math:`\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'`` 。

    .. note:: 
        - `df` 必须大于0。
        - `sd` 必须大于0。
        - `dtype` 必须是float，因为StudentT分布是连续的。
        - 如果在方法函数调用中传入参数 `df` 、 `mean` 或者 `sd` ，则计算中会使用传参值，否则就会使用初始化时的参数值。

    异常：
        - **ValueError** - `df` 中元素不大于0。
        - **ValueError** - `sd` 中元素不大于0。
        - **TypeError** - `dtype` 不是float的子类。

    .. py:method:: log_prob(value, df=None, mean=None, sd=None)

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

        参数：
            - **value** (Tensor) - 要计算的值。
            - **df** (Tensor, 可选) - 分布的自由度。默认值： ``None`` 。
            - **mean** (Tensor, 可选) - 分布的期望。默认值： ``None`` 。
            - **sd** (Tensor, 可选) - 分布的扩散度。默认值： ``None`` 。

        返回：
            Tensor，概率密度函数的对数。