mindspore/docs/api/api_python/nn/mindspore.nn.Perplexity.rst

45 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2022-02-14 11:35:00 +08:00
mindspore.nn.Perplexity
===========================
.. py:class:: mindspore.nn.Perplexity(ignore_label=None)
计算困惑度perplexity。困惑度是衡量一个概率分布或语言模型好坏的标准。低困惑度表明语言模型可以很好地预测样本。计算方式如下
.. math::
PP(W)=P(w_{1}w_{2}...w_{N})^{-\frac{1}{N}}=\sqrt[N]{\frac{1}{P(w_{1}w_{2}...w_{N})}}
**参数:**
- **ignore_label** (int) - 计数时要忽略的无效标签的索引。如果设置为None它将包括所有条目。默认值-1。
.. py:method:: clear()
内部评估结果清零。
.. py:method:: eval()
返回当前评估结果。
**返回:**
numpy.float64计算得到的困惑度结果。
**异常:**
- **RuntimeError** - 样本量为0。
.. py:method:: update(*inputs)
使用 :math:`preds`:math:`labels` 更新内部评估结果。
**参数:**
2022-03-10 11:26:08 +08:00
- **inputs** - 输入 `preds``labels``preds``labels` 是Tensor、list或numpy.ndarray。 `preds` 是预测值, `labels` 是数据的标签。 `preds``labels` 的shape都是 :math:`(N, C)`
2022-02-14 11:35:00 +08:00
**异常:**
- **ValueError** - 输入数量不是2。
- **RuntimeError** - 预测值和标签的长度不同。
- **RuntimeError** - 预测值和标签的shape不同。