mindformers.core.PerplexityMetric
=================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/r2.4.10/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindformers/blob/r1.3.0/docs/api/api_python/core/mindformers.core.PerplexityMetric.rst
    :alt: 查看源文件


.. py:class:: mindformers.core.PerplexityMetric()

    困惑度定义为模型对测试集中每个词分配的负对数概率的指数平均值。对于一个词序列 :math:`W = (w_1, w_2, \ldots, w_N)` ，困惑度 (PP) 可以表示为：

    .. math::
        PP(W) = P(w_1, w_2, \ldots, w_N)^{-\frac{1}{N}} = \sqrt[N]{\frac{1}{P(w_1, w_2, \ldots, w_N)}}

    其中， :math:`P(w_1, w_2, \ldots, w_N)` 表示该序列在模型下的概率。

    在实际应用中，困惑度可以重写为：

    .. math::
        PP(W) = \exp\left(-\frac{1}{N} \sum_{i=1}^{N} \log P(w_i | w_1, w_2, \ldots, w_{i-1})\right)

    该公式表明，较低的困惑度意味着语言模型性能更好，因为这表示模型对实际的词序赋予了更高的概率。

    .. py:method:: clear()

        清除局部评估结果。

    .. py:method:: eval()

        计算评估结果。

        返回：
            评估结果字典，包含 loss 和 PPL 分数。

    .. py:method:: update(*inputs)

        更新局部评估结果。

        参数：
            - **\*inputs** (List) - 逻辑值、标签和输入掩码。其中逻辑值是形状为 :math:`[N,S,W]` 的张量，数据类型为Float16或Float32；标签和输入掩码是形状为 :math:`[N,S]` 的张量，数据类型为Int32或Int64。其中 :math:`N` 为批次大小， :math:`S` 为序列长度， :math:`W` 为词表大小。