mindspore/docs/api/api_python/nn/mindspore.nn.CosineSimilari...

37 lines
1.0 KiB
ReStructuredText
Raw Normal View History

2022-02-15 10:53:07 +08:00
mindspore.nn.CosineSimilarity
=============================
.. py:class:: mindspore.nn.CosineSimilarity(similarity='cosine', reduction='none', zero_diagonal=True)
2022-03-28 17:31:19 +08:00
计算余弦相似度。
2022-02-15 10:53:07 +08:00
**参数:**
2022-03-28 17:31:19 +08:00
- **similarity** (str) - "dot"或"cosine"。"cosine"表示相似度计算逻辑, "dot"表示矩阵点乘矩阵计算逻辑。默认值:"cosine"。
2022-02-15 10:53:07 +08:00
- **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)
使用y_pred和y更新内部评估结果。
**参数:**
- **inputs** (Union[Tensor, list, numpy.ndarray]) - 输入的矩阵。