33 lines
1.1 KiB
ReStructuredText
33 lines
1.1 KiB
ReStructuredText
mindspore.train.CosineSimilarity
|
||
=================================
|
||
|
||
.. py:class:: mindspore.train.CosineSimilarity(similarity='cosine', reduction='none', zero_diagonal=True)
|
||
|
||
计算余弦相似度。
|
||
|
||
参数:
|
||
- **similarity** (str,可选) - 计算逻辑。 ``'cosine'`` 表示相似度计算逻辑, ``'dot'`` 表示矩阵点乘计算逻辑。默认值: ``'cosine'`` 。
|
||
- **reduction** (str,可选) - 规约计算方式。支持 ``'none'`` 、 ``'sum'`` 或 ``'mean'`` 。默认值: ``'none'`` 。
|
||
- **zero_diagonal** (bool,可选) - 如果为 ``True`` ,则对角线将设置为零。默认值: ``True`` 。
|
||
|
||
.. py:method:: clear()
|
||
|
||
重置评估结果。
|
||
|
||
.. py:method:: eval()
|
||
|
||
计算Cosine Similarity矩阵。
|
||
|
||
返回:
|
||
numpy.ndarray,相似度矩阵。
|
||
|
||
异常:
|
||
- **RuntimeError** - 如果没有先调用 `update` 方法。
|
||
|
||
.. py:method:: update(*inputs)
|
||
|
||
使用 `inputs` 更新内部评估结果。
|
||
|
||
参数:
|
||
- **inputs** (Union[Tensor, list, numpy.ndarray]) - 输入的矩阵,包含 `y_pred` 和 `y` 。
|